API Documentation
RenderContext.h
1 // RenderContext.h
3 //
5 
6 namespace nkGraphics
7 {
14  {
15  public :
16 
20  virtual ~RenderContext () ;
21 
22  // Getters
26  Texture* getBackBuffer () const ;
30  Texture* getDepthBuffer () const ;
34  GlobalTimer* getTimer () const ;
38  Viewport* getViewport () const ;
46  Camera* getRenderCamera () const ;
54  Camera* getLodCamera () const ;
58  int getWidth () const ;
62  int getHeight () const ;
66  bool isWindowFocused () const ;
74  bool getOwnsSurface () const ;
75 
76  // Setters
82  void setCompositor (Compositor* value) ;
90  void setRenderCamera (Camera* value) ;
98  void setCullingCamera (Camera* value) ;
106  void setLodCamera (Camera* value) ;
112  void setOwnsSurface (bool value) ;
118  virtual void setGammaCorrected (bool value) = 0 ;
119 
123  virtual void initialize (const RenderContextDescriptor& descriptor) = 0 ;
124 
128  virtual void swap () = 0 ;
129 
140  virtual void refreshBufferSize (unsigned int width = 0, unsigned int height = 0) = 0 ;
144  virtual void refreshViewportSize () ;
145  } ;
146 }
nkGraphics::RenderContext::getHeight
int getHeight() const
nkGraphics::RenderContext::getCullingCamera
Camera * getCullingCamera() const
nkGraphics::Camera
Offers all controls to model a camera.
Definition: Camera.h:14
nkGraphics::RenderContext::getAttachedWin
nkWinUi::Window * getAttachedWin() const
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition: Texture.h:35
nkGraphics::Viewport
Holds all the information needed about a viewport.
Definition: Viewport.h:14
nkGraphics::RenderContextDescriptor
A descriptor, used when creating a context along with its window.
Definition: RenderContextDescriptor.h:14
nkGraphics::Compositor
A compositor, describing how to compose the rendering pipeline.
Definition: Compositor.h:23
nkGraphics::RenderContext::getViewport
Viewport * getViewport() const
nkGraphics::RenderContext::refreshViewportSize
virtual void refreshViewportSize()
nkGraphics::RenderContext::getWidth
int getWidth() const
nkGraphics::RenderContext
A rendering context, attached to a window or an offscreen texture.
Definition: RenderContext.h:14
nkGraphics::RenderContext::initialize
virtual void initialize(const RenderContextDescriptor &descriptor)=0
nkGraphics::RenderContext::isWindowFocused
bool isWindowFocused() const
nkGraphics::RenderContext::swap
virtual void swap()=0
nkGraphics::RenderContext::getBackBuffer
Texture * getBackBuffer() const
nkGraphics::RenderContext::getCompositor
Compositor * getCompositor() const
nkGraphics::RenderContext::setRenderCamera
void setRenderCamera(Camera *value)
nkGraphics::RenderContext::setGammaCorrected
virtual void setGammaCorrected(bool value)=0
nkWinUi::Window
A graphical window, made for general purpose.
Definition: Window.h:14
nkGraphics::RenderContext::refreshBufferSize
virtual void refreshBufferSize(unsigned int width=0, unsigned int height=0)=0
nkGraphics::RenderContext::getDepthBuffer
Texture * getDepthBuffer() const
nkGraphics::RenderContext::setLodCamera
void setLodCamera(Camera *value)
nkGraphics::RenderContext::setCullingCamera
void setCullingCamera(Camera *value)
nkGraphics::RenderContext::getTimer
GlobalTimer * getTimer() const
nkGraphics::GlobalTimer
A timer, giving timing capabilities.
Definition: GlobalTimer.h:12
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::RenderContext::getOwnsSurface
bool getOwnsSurface() const
nkGraphics::RenderContext::setCompositor
void setCompositor(Compositor *value)
nkGraphics::RenderContext::getRenderCamera
Camera * getRenderCamera() const
nkGraphics::RenderContext::setOwnsSurface
void setOwnsSurface(bool value)
nkGraphics::RenderContext::getLodCamera
Camera * getLodCamera() const
nkGraphics::RenderContext::~RenderContext
virtual ~RenderContext()