Ogre::GL3PlusRenderPassDescriptor Class Reference

GL3+ will share FBO handles between all GL3PlusRenderPassDescriptor that share the same FBO setup. More...

#include <OgreGL3PlusRenderPassDescriptor.h>

Inheritance diagram for Ogre::GL3PlusRenderPassDescriptor:

Public Types
enum	EntryTypes {   Colour0 = 1u << 0u, Colour1 = 1u << 1u, Colour2 = 1u << 2u, Colour3 = 1u << 3u,   Colour4 = 1u << 4u, Colour5 = 1u << 5u, Colour6 = 1u << 6u, Colour7 = 1u << 7u,   Depth = 1u << 30u, Stencil = 1u << 31u, Colour = Colour0|Colour1|Colour2|Colour3|Colour4|Colour5|Colour6|Colour7, All = Colour|Depth|Stencil }

Public Member Functions
	GL3PlusRenderPassDescriptor (GL3PlusRenderSystem *renderSystem)
virtual	~GL3PlusRenderPassDescriptor ()
void	checkWarnIfRtvWasFlushed (uint32 entriesToFlush)
virtual void	entriesModified (uint32 entryTypes)
	Call this when you're done modified mColour. More...
virtual void	getCustomAttribute (IdString name, void *pData, uint32 extraParam)
GLuint	getFboName (void) const
uint8	getNumColourEntries (void) const
bool	hasAttachment (const TextureGpu *texture) const
virtual bool	hasSameAttachments (const RenderPassDescriptor *otherPassDesc) const
bool	hasStencilFormat (void) const
	Returns true if either Stencil is set, or if Depth is set with depth-stencil attachment. More...
void	operator delete (void *ptr)
void	operator delete (void *ptr, void *)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info More...
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new More...
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info More...
void *	operator new[] (size_t sz)
void	performLoadActions (uint8 blendChannelMask, bool depthWrite, uint32 stencilWriteMask, uint32 entriesToFlush)
void	performStoreActions (bool hasArbInvalidateSubdata, uint32 entriesToFlush)
bool	requiresTextureFlipping (void) const
virtual void	setClearColour (uint8 idx, const ColourValue &clearColour)
	Sets the clear colour to specific entry. More...
virtual void	setClearColour (const ColourValue &clearColour)
	Sets the clear colour to all entries. More...
virtual void	setClearDepth (Real clearDepth)
virtual void	setClearStencil (uint32 clearStencil)
uint32	willSwitchTo (GL3PlusRenderPassDescriptor *newDesc, bool warnIfRtvWasFlushed) const

Public Attributes
RenderPassColourTarget	mColour [OGRE_MAX_MULTIPLE_RENDER_TARGETS]
RenderPassDepthTarget	mDepth
bool	mInformationOnly
	When true, beginRenderPassDescriptor & endRenderPassDescriptor won't actually load/store this pass descriptor; but will still set the mCurrentRenderPassDescriptor so we have required information by some passes. More...
RenderPassStencilTarget	mStencil

Detailed Description

GL3+ will share FBO handles between all GL3PlusRenderPassDescriptor that share the same FBO setup.

This doesn't mean these RenderPassDescriptor are exactly the same, as they may have different clear, loadAction or storeAction values.

Member Enumeration Documentation

EntryTypes

enum Ogre::RenderPassDescriptor::EntryTypes

inherited

Enumerator
Colour0
Colour1
Colour2
Colour3
Colour4
Colour5
Colour6
Colour7
Depth
Stencil
Colour
All

Constructor & Destructor Documentation

GL3PlusRenderPassDescriptor()

Ogre::GL3PlusRenderPassDescriptor::GL3PlusRenderPassDescriptor

(

GL3PlusRenderSystem *

renderSystem

)

~GL3PlusRenderPassDescriptor()

virtual Ogre::GL3PlusRenderPassDescriptor::~GL3PlusRenderPassDescriptor ( )

virtual

Member Function Documentation

checkWarnIfRtvWasFlushed()

void Ogre::RenderPassDescriptor::checkWarnIfRtvWasFlushed ( uint32  entriesToFlush )

inherited

entriesModified()

virtual void Ogre::GL3PlusRenderPassDescriptor::entriesModified ( uint32  entryTypes )

virtual

Call this when you're done modified mColour.

Note there must be no gaps, e.g. mColour[1] is empty but mColour[0] & mColour[2] are not.

Remarks

Values that are modified by calling setClearColour et al don't need to call entriesModified. Prefer changing those values using those calls since it's faster.

Parameters

entryTypes

Bitmask. See EntryTypes

Reimplemented from Ogre::RenderPassDescriptor.

getCustomAttribute()

virtual void Ogre::RenderPassDescriptor::getCustomAttribute ( IdString  name, void *  pData, uint32  extraParam  )

inlinevirtualinherited

Parameters

name	When it's set to "ID3D11RenderTargetView", extraParam must be in range [0;OGRE_MAX_MULTIPLE_RENDER_TARGETS) When it's set to "ID3D11DepthStencilView", extraParam can be any value
pData	Output
extraParam	See name

Reimplemented in Ogre::D3D11RenderPassDescriptor.

getFboName()

GLuint Ogre::GL3PlusRenderPassDescriptor::getFboName ( void  ) const

inline

getNumColourEntries()

uint8 Ogre::RenderPassDescriptor::getNumColourEntries ( void  ) const

inlineinherited

hasAttachment()

bool Ogre::RenderPassDescriptor::hasAttachment ( const TextureGpu *  texture ) const

inherited

hasSameAttachments()

virtual bool Ogre::RenderPassDescriptor::hasSameAttachments ( const RenderPassDescriptor *  otherPassDesc ) const

virtualinherited

hasStencilFormat()

bool Ogre::RenderPassDescriptor::hasStencilFormat ( void  ) const

inherited

Returns true if either Stencil is set, or if Depth is set with depth-stencil attachment.

operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr )

inlineinherited

operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr, void *    )

inlineinherited

operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr, const char *  , int  , const char *    )

inlineinherited

operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr )

inlineinherited

operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr, const char *  , int  , const char *    )

inlineinherited

operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz, const char *  file, int  line, const char *  func  )

inlineinherited

operator new, with debug line info

operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz )

inlineinherited

operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz, void *  ptr  )

inlineinherited

placement operator new

operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz, const char *  file, int  line, const char *  func  )

inlineinherited

array operator new, with debug line info

operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz )

inlineinherited

performLoadActions()

void Ogre::GL3PlusRenderPassDescriptor::performLoadActions	(	uint8	blendChannelMask,
		bool	depthWrite,
		uint32	stencilWriteMask,
		uint32	entriesToFlush
	)

performStoreActions()

void Ogre::GL3PlusRenderPassDescriptor::performStoreActions	(	bool	hasArbInvalidateSubdata,
		uint32	entriesToFlush
	)

requiresTextureFlipping()

bool Ogre::RenderPassDescriptor::requiresTextureFlipping ( void  ) const

inlineinherited

setClearColour() [1/2]

virtual void Ogre::GL3PlusRenderPassDescriptor::setClearColour ( uint8  idx, const ColourValue &  clearColour  )

virtual

Sets the clear colour to specific entry.

Reimplemented from Ogre::RenderPassDescriptor.

setClearColour() [2/2]

virtual void Ogre::GL3PlusRenderPassDescriptor::setClearColour ( const ColourValue &  clearColour )

virtual

Sets the clear colour to all entries.

In some APIs may be faster than calling setClearColour( idx, clearColour ) for each entry individually.

Reimplemented from Ogre::RenderPassDescriptor.

setClearDepth()

virtual void Ogre::RenderPassDescriptor::setClearDepth ( Real  clearDepth )

virtualinherited

Reimplemented in Ogre::MetalRenderPassDescriptor.

setClearStencil()

virtual void Ogre::RenderPassDescriptor::setClearStencil ( uint32  clearStencil )

virtualinherited

Reimplemented in Ogre::MetalRenderPassDescriptor.

willSwitchTo()

uint32 Ogre::GL3PlusRenderPassDescriptor::willSwitchTo	(	GL3PlusRenderPassDescriptor *	newDesc,
		bool	warnIfRtvWasFlushed
	)		const

Member Data Documentation

mColour

RenderPassColourTarget Ogre::RenderPassDescriptor::mColour[OGRE_MAX_MULTIPLE_RENDER_TARGETS]

inherited

mDepth

RenderPassDepthTarget Ogre::RenderPassDescriptor::mDepth

inherited

mInformationOnly

bool Ogre::RenderPassDescriptor::mInformationOnly

inherited

When true, beginRenderPassDescriptor & endRenderPassDescriptor won't actually load/store this pass descriptor; but will still set the mCurrentRenderPassDescriptor so we have required information by some passes.

Examples of these are stencil passes.

mStencil

RenderPassStencilTarget Ogre::RenderPassDescriptor::mStencil

inherited

---

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

• OgreGL3PlusRenderPassDescriptor.h