BaseRenderWindow< T > Class Template Reference
#include <BaseRenderTarget.hh>
Public Member Functions | |
BaseRenderWindow () | |
virtual | ~BaseRenderWindow () |
virtual double | DevicePixelRatio () const |
Get the device to pixel ratio. More... | |
virtual std::string | Handle () const |
Get the window handle that the render window is attached to. More... | |
virtual void | OnMove () |
Alert the window of a window move event. More... | |
virtual void | OnResize (const unsigned int _width, const unsigned int _height) |
Alert the window of a window resize event. More... | |
virtual void | SetDevicePixelRatio (const double _ratio) |
Set the device to pixel ratio. More... | |
virtual void | SetHandle (const std::string &_handle) |
Set the window handle to attach the render window to. More... | |
Public Member Functions inherited from RenderWindow | |
virtual | ~RenderWindow () |
Destructor. More... | |
Public Member Functions inherited from RenderTarget | |
virtual | ~RenderTarget () |
Destructor. More... | |
virtual void | AddRenderPass (const RenderPassPtr &_pass)=0 |
Add a render pass to the render target. More... | |
virtual math::Color | BackgroundColor () const =0 |
Get the background color of the render target. This should be the same as the scene background color. More... | |
virtual void | Copy (Image &_image) const =0 |
Write rendered image to given Image. The RenderTarget will convert the underlying image to the specified format listed in the given Image. However if the given image is not of the correct size no work will be done. Calling this function before an image has been rendered will result in undefined behavior. More... | |
virtual PixelFormat | Format () const =0 |
Set the render target image format. More... | |
virtual unsigned int | Height () const =0 |
Get render target height in pixels. More... | |
virtual void | PreRender (const CameraPtr &_camera)=0 |
See Object::PreRender. This function will call Object::PreRender but with the added bonus that it has access to the camera that is about to render. More... | |
virtual bool | Reinterpretable () const =0 |
See SetFormat() More... | |
virtual void | RemoveAllRenderPasses ()=0 |
Remove all render passes from the render target. More... | |
virtual void | RemoveRenderPass (const RenderPassPtr &_pass)=0 |
Remove a render pass from the render target. More... | |
virtual RenderPassPtr | RenderPassByIndex (unsigned int _index) const =0 |
Get a render pass by index. More... | |
virtual unsigned int | RenderPassCount () const =0 |
Get the number of render passes applied to the render target. More... | |
virtual void | SetFormat (PixelFormat _format, bool _reinterpretable=false)=0 |
Set the render target image format. More... | |
virtual void | SetHeight (const unsigned int _height)=0 |
Set the render target height in pixels. More... | |
virtual void | SetWidth (const unsigned int _width)=0 |
Set the render target width in pixels. More... | |
virtual unsigned int | Width () const =0 |
Get render target width in pixels. More... | |
Public Member Functions inherited from Object | |
virtual | ~Object () |
Destructor. More... | |
virtual void | Destroy ()=0 |
Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More... | |
virtual unsigned int | Id () const =0 |
Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More... | |
virtual std::string | Name () const =0 |
Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More... | |
virtual void | PostRender ()=0 |
Post process this object and any of its children after rendering. More... | |
virtual void | PreRender ()=0 |
Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More... | |
virtual ScenePtr | Scene () const =0 |
Get the Scene that created this object. More... | |
Protected Attributes | |
std::string | handle |
double | ratio = 1.0 |
Constructor & Destructor Documentation
◆ BaseRenderWindow()
◆ ~BaseRenderWindow()
|
virtual |
Member Function Documentation
◆ DevicePixelRatio()
|
virtual |
◆ Handle()
|
virtual |
Get the window handle that the render window is attached to.
- Returns
- Window handle
Implements RenderWindow.
◆ OnMove()
|
virtual |
Alert the window of a window move event.
Implements RenderWindow.
◆ OnResize()
|
virtual |
Alert the window of a window resize event.
- Parameters
-
[in] _width New window width in pixels [in] _height New window height in pixels
Implements RenderWindow.
◆ SetDevicePixelRatio()
|
virtual |
◆ SetHandle()
|
virtual |
Set the window handle to attach the render window to.
- Parameters
-
[in] _handle Window handle
Implements RenderWindow.
Member Data Documentation
◆ handle
|
protected |
◆ ratio
|
protected |
The documentation for this class was generated from the following file: