OGRE  14.2
Object-Oriented Graphics Rendering Engine
Ogre::GL3PlusFBORenderTexture Class Reference

RenderTexture for GL FBO. More...

#include <OgreGL3PlusFBORenderTexture.h>

+ Inheritance diagram for Ogre::GL3PlusFBORenderTexture:

Public Member Functions

 GL3PlusFBORenderTexture (GL3PlusFBOManager *manager, const String &name, const GLSurfaceDesc &target, bool writeGamma, uint fsaa)
 
void _detachDepthBuffer () override
 Detaches DepthBuffer without notifying it from the detach. More...
 
bool attachDepthBuffer (DepthBuffer *depthBuffer) override
 Override so we can attach the depth buffer to the FBO. More...
 
void detachDepthBuffer () override
 
GLContextgetContext () const override
 Get the GL context that needs to be active to render to this target. More...
 
void getCustomAttribute (const String &name, void *pData) override
 Retrieve a platform or API-specific piece of information. More...
 
GLFrameBufferObjectCommongetFBO () override
 
void swapBuffers () override
 Override needed to deal with multisample buffers. More...
 
- Public Member Functions inherited from Ogre::GLRenderTexture
 GLRenderTexture (const String &name, const GLSurfaceDesc &target, bool writeGamma, uint fsaa)
 
bool requiresTextureFlipping () const override
 
- Public Member Functions inherited from Ogre::RenderTexture
 RenderTexture (HardwarePixelBuffer *buffer, uint32 zoffset)
 
virtual ~RenderTexture ()
 
void copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer=FB_AUTO) override
 Copies the current contents of the render target to a pixelbox. More...
 
virtual void copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer=FB_AUTO)=0
 Copies the current contents of the render target to a pixelbox. More...
 
void copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer=FB_AUTO)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
PixelFormat suggestPixelFormat () const override
 Suggests a pixel format to use for extracting the data in this target, when calling copyContentsToMemory. More...
 
- Public Member Functions inherited from Ogre::RenderTarget
 RenderTarget ()
 
virtual ~RenderTarget ()
 
virtual void _beginUpdate ()
 Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc. More...
 
virtual void _endUpdate ()
 Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'. More...
 
virtual void _notifyCameraRemoved (const Camera *cam)
 Utility method to notify a render target that a camera has been removed, in case it was referring to it as a viewer. More...
 
virtual void _updateAutoUpdatedViewports (bool updateStatistics=true)
 Method for manual management of rendering - renders only viewports that are auto updated. More...
 
virtual void _updateViewport (int zorder, bool updateStatistics=true)
 Method for manual management of rendering - renders the given viewport (even if it is not autoupdated) More...
 
virtual void _updateViewport (Viewport *viewport, bool updateStatistics=true)
 Method for manual management of rendering - renders the given viewport (even if it is not autoupdated) More...
 
virtual void addListener (RenderTargetListener *listener)
 Add a listener to this RenderTarget which will be called back before & after rendering. More...
 
virtual ViewportaddViewport (Camera *cam, int ZOrder=0, float left=0.0f, float top=0.0f, float width=1.0f, float height=1.0f)
 Adds a viewport to the rendering target. More...
 
void copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer=FB_AUTO)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
uint getCustomAttribute (const String &name)
 simplified API for bindings More...
 
DepthBuffergetDepthBuffer () const
 
uint16 getDepthBufferPool () const
 
virtual uint getFSAA () const
 Indicates whether multisampling is performed on rendering and at what level. More...
 
virtual const StringgetFSAAHint () const
 RenderSystem specific FSAA option. See RenderSystem::_createRenderWindow for details. More...
 
virtual uint32 getHeight (void) const
 
void getMetrics (unsigned int &width, unsigned int &height)
 Retrieve information about the render target. More...
 
virtual const StringgetName (void) const
 Retrieve target's name. More...
 
virtual unsigned short getNumViewports (void) const
 Returns the number of viewports attached to this target. More...
 
virtual uchar getPriority () const
 Gets the priority of a render target. More...
 
const FrameStatsgetStatistics (void) const
 Retrieves details of current rendering performance. More...
 
virtual ViewportgetViewport (unsigned short index)
 Retrieves a pointer to the viewport with the given index. More...
 
virtual ViewportgetViewportByZOrder (int ZOrder)
 Retrieves a pointer to the viewport with the given Z-order. More...
 
virtual uint32 getWidth (void) const
 
virtual bool hasViewportWithZOrder (int ZOrder)
 Returns true if and only if a viewport exists at the given Z-order. More...
 
virtual void insertListener (RenderTargetListener *listener, const unsigned int pos=0)
 same as addListener, but force the position in the vector, so we can control the call order More...
 
virtual bool isActive () const
 Used to retrieve or set the active state of the render target. More...
 
virtual bool isAutoUpdated (void) const
 Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. More...
 
virtual bool isHardwareGammaEnabled () const
 Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space. More...
 
virtual bool isPrimary (void) const
 Indicates whether this target is the primary window. More...
 
virtual bool isStereoEnabled (void) const
 Indicates whether stereo is currently enabled for this target. More...
 
virtual void removeAllListeners (void)
 Removes all listeners from this instance. More...
 
virtual void removeAllViewports (void)
 Removes all viewports on this target. More...
 
virtual void removeListener (RenderTargetListener *listener)
 Removes a RenderTargetListener previously registered using addListener. More...
 
virtual void removeViewport (int ZOrder)
 Removes a viewport at a given Z-order. More...
 
void resetStatistics (void)
 Resets saved frame-rate statistices. More...
 
virtual void setActive (bool state)
 Used to set the active state of the render target. More...
 
virtual void setAutoUpdated (bool autoupdate)
 Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. More...
 
void setDepthBufferPool (uint16 poolId)
 Sets the pool ID this RenderTarget should query from. More...
 
virtual void setFSAA (uint fsaa, const String &fsaaHint)
 Set the level of multisample AA to be used if hardware support it. More...
 
virtual void setPriority (uchar priority)
 Sets the priority of this render target in relation to the others. More...
 
virtual void update (bool swapBuffers=true)
 Tells the target to update it's contents. More...
 
void writeContentsToFile (const String &filename)
 Writes the current contents of the render target to the named file. More...
 
virtual String writeContentsToTimestampedFile (const String &filenamePrefix, const String &filenameSuffix)
 Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file. More...
 
- Public Member Functions inherited from Ogre::GLRenderTarget
virtual ~GLRenderTarget ()
 

Additional Inherited Members

- Public Types inherited from Ogre::RenderTarget
enum  FrameBuffer { FB_FRONT , FB_BACK , FB_AUTO }
 
- Static Public Attributes inherited from Ogre::GLRenderTexture
static const String CustomAttributeString_FBO
 
static const String CustomAttributeString_GLCONTEXT
 
static const String CustomAttributeString_TARGET
 

Detailed Description

RenderTexture for GL FBO.

Constructor & Destructor Documentation

◆ GL3PlusFBORenderTexture()

Ogre::GL3PlusFBORenderTexture::GL3PlusFBORenderTexture ( GL3PlusFBOManager manager,
const String name,
const GLSurfaceDesc target,
bool  writeGamma,
uint  fsaa 
)

Member Function Documentation

◆ getCustomAttribute()

void Ogre::GL3PlusFBORenderTexture::getCustomAttribute ( const String name,
void *  pData 
)
overridevirtual

Retrieve a platform or API-specific piece of information.

This method of retrieving information should only be used if you know what you're doing.

Name Description
WINDOW The native window handle. (X11 Window XID/ HWND / NSWindow*)
HWND deprecated (same as WINDOW)
GL_FBOID the id of the OpenGL framebuffer object
GL_MULTISAMPLEFBOID the id of the OpenGL framebuffer object used for multisampling
GLFBO id of the screen OpenGL framebuffer object on iOS
GLCONTEXT deprecated, do not use
FBO deprecated, do not use
TARGET deprecated, do not use
XDISPLAY The X Display connection behind that context.
ATOM The X Atom used in client delete events.
VIEW Cocoa NSView*
NSOPENGLCONTEXT Cocoa NSOpenGLContext*
NSOPENGLPIXELFORMAT Cocoa NSOpenGLPixelFormat*
Parameters
nameThe name of the attribute.
pDataPointer to memory of the right kind of structure to receive the info.

Reimplemented from Ogre::RenderTarget.

◆ swapBuffers()

void Ogre::GL3PlusFBORenderTexture::swapBuffers ( )
overridevirtual

Override needed to deal with multisample buffers.

Reimplemented from Ogre::RenderTarget.

◆ attachDepthBuffer()

bool Ogre::GL3PlusFBORenderTexture::attachDepthBuffer ( DepthBuffer depthBuffer)
overridevirtual

Override so we can attach the depth buffer to the FBO.

Reimplemented from Ogre::RenderTarget.

◆ detachDepthBuffer()

void Ogre::GL3PlusFBORenderTexture::detachDepthBuffer ( )
overridevirtual

Reimplemented from Ogre::RenderTarget.

◆ _detachDepthBuffer()

void Ogre::GL3PlusFBORenderTexture::_detachDepthBuffer ( )
overridevirtual

Detaches DepthBuffer without notifying it from the detach.

Useful when called from the DepthBuffer while it iterates through attached RenderTargets (

See also
DepthBuffer::_setPoolId())

Reimplemented from Ogre::RenderTarget.

◆ getContext()

GLContext* Ogre::GL3PlusFBORenderTexture::getContext ( ) const
inlineoverridevirtual

Get the GL context that needs to be active to render to this target.

Implements Ogre::GLRenderTarget.

◆ getFBO()

GLFrameBufferObjectCommon* Ogre::GL3PlusFBORenderTexture::getFBO ( )
inlineoverridevirtual

Reimplemented from Ogre::GLRenderTarget.


The documentation for this class was generated from the following file: