Ogre2RenderWindow Class Reference
Ogre2.x implementation of the render window class. More...
#include <Ogre2RenderTarget.hh>
Public Member Functions | |
| virtual | ~Ogre2RenderWindow () |
| Destructor. More... | |
| virtual void | Destroy () override |
| Destroy the render target. More... | |
| virtual bool | IsRenderWindow () const override |
| Returns true if this is a render window. More... | |
| virtual Ogre::TextureGpu * | RenderTarget () const override |
| Get a pointer to the ogre render target containing the results of the render. More... | |
 Public Member Functions inherited from BaseRenderWindow< Ogre2RenderTarget > | |
| 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... | |
| Public Member Functions inherited from Object | |
| virtual | ~Object () |
| Destructor. 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 ScenePtr | Scene () const =0 |
| Get the Scene that created this object. More... | |
| Public Member Functions inherited from Ogre2RenderTarget | |
| virtual | ~Ogre2RenderTarget () |
| Destructor. More... | |
| virtual unsigned int | AntiAliasing () const |
| Get the anti-aliasing level. More... | |
| virtual math::Color | BackgroundColor () const override |
| Get the background color of the render target. This should be the same as the scene background color. More... | |
| virtual MaterialPtr | BackgroundMaterial () const |
| Get the background material of this camera. More... | |
| virtual Ogre::Camera * | Camera () const |
| Get a pointer to the internal ogre camera. More... | |
| virtual void | Copy (Image &_image) const override |
| Copy the render target buffer data to an image. More... | |
| unsigned int | GLIdImpl () const |
| void | MetalIdImpl (void *_textureIdPtr) const |
| virtual void | PostRender () override |
| Post process this object and any of its children after rendering. More... | |
| void | PrepareForExternalSampling () |
| See Camera::PrepareForExternalSampling. More... | |
| virtual void | PreRender () override |
| 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 void | Render () |
| Main render call. More... | |
| virtual void | SetAntiAliasing (unsigned int _aa) |
| set the anti-aliasing level More... | |
| virtual void | SetBackgroundColor (math::Color _color) |
| Set the background color of the render target. More... | |
| virtual void | SetBackgroundMaterial (MaterialPtr _material) |
| Set the background material of this camera. More... | |
| virtual void | SetCamera (Ogre::Camera *_camera) |
| Set the ogre camera to use for this render target. More... | |
| void | SetMaterial (MaterialPtr _material) |
| Set a material to render on every object. This method is used for special cases like the render target of a depth camera. More... | |
| void | SetShadowsNodeDefDirty () |
| virtual void | SetVisibilityMask (uint32_t _mask) |
| Set visibility mask for the viewport associated with this render target. More... | |
| virtual uint32_t | VisibilityMask () const |
| Get visibility mask for the viewport associated with this render target. More... | |
| Public Member Functions inherited from BaseRenderTarget< Ogre2Object > | |
| BaseRenderTarget () | |
| virtual | ~BaseRenderTarget () |
| virtual void | AddRenderPass (const RenderPassPtr &_pass) override |
| Add a render pass to the render target. More... | |
| virtual PixelFormat | Format () const override |
| Set the render target image format. More... | |
| virtual unsigned int | Height () const override |
| Get render target height in pixels. More... | |
| virtual void | PreRender (const CameraPtr &_camera) override |
| 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 override |
| See SetFormat() More... | |
| void | RemoveAllRenderPasses () override |
| Remove all render passes from the render target. More... | |
| virtual void | RemoveRenderPass (const RenderPassPtr &_pass) override |
| Remove a render pass from the render target. More... | |
| virtual RenderPassPtr | RenderPassByIndex (unsigned int _index) const override |
| Get a render pass by index. More... | |
| virtual unsigned int | RenderPassCount () const override |
| Get the number of render passes applied to the render target. More... | |
| virtual void | SetFormat (PixelFormat _format, bool _reinterpretable=false) override |
| Set the render target image format. More... | |
| virtual void | SetHeight (const unsigned int _height) override |
| Set the render target height in pixels. More... | |
| virtual void | SetWidth (const unsigned int _width) override |
| Set the render target width in pixels. More... | |
| virtual unsigned int | Width () const override |
| Get render target width in pixels. More... | |
| Public Member Functions inherited from Ogre2Object | |
| virtual | ~Ogre2Object () |
| Destructor. More... | |
| virtual ScenePtr | Scene () const override |
| Public Member Functions inherited from BaseObject | |
| virtual | ~BaseObject () |
| virtual unsigned int | Id () const override |
| virtual std::string | Name () const override |
Protected Member Functions | |
| Ogre2RenderWindow () | |
| Constructor. More... | |
| virtual void | BuildTarget () |
| Build the render window. More... | |
| virtual void | RebuildTarget () override |
| Rebuild the render target. More... | |
| Protected Member Functions inherited from Ogre2RenderTarget | |
| Ogre2RenderTarget () | |
| Constructor. More... | |
| virtual void | BuildCompositor () |
| Build the compositor. More... | |
| void | BuildTargetImpl () |
| Build the render texture. More... | |
| virtual void | DestroyCompositor () |
| Destroy the compositor. More... | |
| void | DestroyTargetImpl () |
| Destroy the render texture. More... | |
| virtual void | RebuildCompositor () |
| Rebuild the compositor. More... | |
| virtual void | RebuildImpl () override |
| Implementation of the Rebuild function. More... | |
| void | RebuildMaterial () |
| Re-initializes render target material to apply a material to everything in the scene. Does nothing if no material has been set. More... | |
| Ogre::TextureGpu * | RenderTargetImpl () const |
| Get a pointer to the ogre render target containing the results of the render (implemented separately to avoid breaking ABI of the pure virtual function) More... | |
| uint8_t | TargetFSAA () const |
| Returns the FSAA to use based on supported specs by HW and value specified in Ogre2RenderTarget::AntiAliasing. More... | |
| virtual void | UpdateBackgroundColor () |
| Update the background color. More... | |
| virtual void | UpdateBackgroundMaterial () |
| Update the background material. More... | |
| virtual void | UpdateRenderPassChain () |
| Update the render pass chain. More... | |
| Protected Member Functions inherited from BaseRenderTarget< Ogre2Object > | |
| virtual void | Rebuild () |
| Protected Member Functions inherited from Ogre2Object | |
| Ogre2Object () | |
| Constructor. More... | |
| Protected Member Functions inherited from BaseObject | |
| BaseObject () | |
| virtual void | Init () |
| virtual void | Load () |
Protected Attributes | |
| Ogre::TextureGpu * | ogreRenderWindow = nullptr |
| Pointer to the internal ogre render target object. More... | |
| Protected Attributes inherited from BaseRenderWindow< Ogre2RenderTarget > | |
| std::string | handle |
| double | ratio |
| Protected Attributes inherited from Ogre2RenderTarget | |
| unsigned int | antiAliasing = 4 |
| Anti-aliasing level. More... | |
| MaterialPtr | backgroundMaterial |
| Background material of the render target. More... | |
| bool | backgroundMaterialDirty = false |
| Flag to indicate if the render target background material has changed. More... | |
| bool | colorDirty = true |
| Flag to indicate if the render target color has changed. More... | |
| MaterialPtr | material |
| a material used by for the render target More... | |
| Ogre2RenderTargetMaterialPtr | materialApplicator |
| Helper class that applies the material to the render target. More... | |
| Ogre::ColourValue | ogreBackgroundColor |
| Stores the background color of the render target. More... | |
| Ogre::Camera * | ogreCamera = nullptr |
| Pointer to the internal ogre camera. More... | |
| Ogre::CompositorWorkspace * | ogreCompositorWorkspace = nullptr |
| Ogre's compositor workspace - the main interface to render into a render target or render texture. More... | |
| std::string | ogreCompositorWorkspaceDefName |
| Ogre's compositor workspace definition name. More... | |
| uint32_t | visibilityMask = GZ_VISIBILITY_ALL |
| visibility mask associated with this render target More... | |
| Protected Attributes inherited from BaseRenderTarget< Ogre2Object > | |
| PixelFormat | format |
| unsigned int | height |
| bool | reinterpretable |
| bool | renderPassDirty |
| Flag to indicate if render pass need to be rebuilt. More... | |
| std::vector< RenderPassPtr > | renderPasses |
| A chain of render passes applied to the render target. More... | |
| bool | targetDirty |
| unsigned int | width |
| Protected Attributes inherited from Ogre2Object | |
| Ogre2ScenePtr | scene |
| Pointer to the ogre scene. More... | |
| Protected Attributes inherited from BaseObject | |
| unsigned int | id |
| std::string | name |
Additional Inherited Members | |
| Static Public Member Functions inherited from Ogre2RenderTarget | |
| static uint8_t | TargetFSAA (uint8_t _fsaa) |
| Returns the FSAA to use based on supported specs by HW and value specified in _fsaa. More... | |
| static void | UpdateRenderPassChain (Ogre::CompositorWorkspace *_workspace, const std::string &_workspaceDefName, const std::string &_baseNode, const std::string &_finalNode, const std::vector< RenderPassPtr > &_renderPasses, bool _recreateNodes, Ogre::TextureGpu *(*_ogreTextures)[2], bool _isRenderWindow) |
| Update the render pass chain. More... | |
Detailed Description
Ogre2.x implementation of the render window class.
Constructor & Destructor Documentation
◆ Ogre2RenderWindow()
|
protected |
Constructor.
◆ ~Ogre2RenderWindow()
|
virtual |
Destructor.
Member Function Documentation
◆ BuildTarget()
|
protectedvirtual |
Build the render window.
◆ Destroy()
|
overridevirtual |
Destroy the render target.
Implements Ogre2RenderTarget.
◆ IsRenderWindow()
|
overridevirtual |
Returns true if this is a render window.
- Returns
- True if this render target is a render window
Reimplemented from Ogre2RenderTarget.
◆ RebuildTarget()
|
overrideprotectedvirtual |
Rebuild the render target.
Implements Ogre2RenderTarget.
◆ RenderTarget()
|
overridevirtual |
Get a pointer to the ogre render target containing the results of the render.
Implements Ogre2RenderTarget.
Member Data Documentation
◆ ogreRenderWindow
|
protected |
Pointer to the internal ogre render target object.
The documentation for this class was generated from the following file: