RenderBuffer can be used with RenderTarget as buffer for writing or with TextureSampler as buffer for reading. More...

#include <RenderBuffer.h>

Inheritance diagram for ramses::RenderBuffer:

Collaboration diagram for ramses::RenderBuffer:

Public Member Functions
uint32_t	getWidth () const
	Returns the width of the RenderBuffer in pixels. More...

uint32_t	getHeight () const
	Returns the height of the RenderBuffer in pixels. More...

ERenderBufferType	getBufferType () const
	Returns the type of the RenderBuffer. More...

ERenderBufferFormat	getBufferFormat () const
	Returns the data format of the RenderBuffer. More...

ERenderBufferAccessMode	getAccessMode () const
	Returns the read/write access mode of the RenderBuffer. More...

uint32_t	getSampleCount () const
	Returns the sample count used for MSAA. More...

Public Member Functions inherited from ramses::SceneObject
sceneObjectId_t	getSceneObjectId () const
	Returns scene object id which is automatically assigned at creation time of object and is unique within scope of one scene. More...

sceneId_t	getSceneId () const
	Returns sceneid to which this object belongs to. More...

Public Member Functions inherited from ramses::RamsesObject
const char *	getName () const
	Returns the name of the object. More...

status_t	setName (const char *name)
	Changes the name of the object. More...

ERamsesObjectType	getType () const
	Gets type of the object. More...

bool	isOfType (ERamsesObjectType type) const
	Checks if the object is of given type. More...

Public Member Functions inherited from ramses::StatusObject
status_t	validate () const
	Generates verbose validation of the object. More...

const char *	getValidationReport (EValidationSeverity minSeverity=EValidationSeverity_Info) const
	Provides verbose report in human readable form generated by validate. More...

const char *	getStatusMessage (status_t status) const
	Get the string description for a status provided by a RAMSES API function. More...

	StatusObject (const StatusObject &other)=delete
	Deleted copy constructor. More...

StatusObject &	operator= (const StatusObject &other)=delete
	Deleted copy assignment. More...

Public Attributes
class RenderBufferImpl &	impl

Public Attributes inherited from ramses::SceneObject
class SceneObjectImpl &	impl

Public Attributes inherited from ramses::ClientObject
class ClientObjectImpl &	impl

Public Attributes inherited from ramses::RamsesObject
class RamsesObjectImpl &	impl

Public Attributes inherited from ramses::StatusObject
class StatusObjectImpl &	impl

Protected Member Functions
	RenderBuffer (RenderBufferImpl &pimpl)
	Constructor for RenderBuffer. More...

virtual	~RenderBuffer ()
	Destructor of the RenderBuffer. More...

Protected Member Functions inherited from ramses::SceneObject
	SceneObject (SceneObjectImpl &pimpl)
	Constructor for SceneObject. More...

virtual	~SceneObject ()
	Destructor of the SceneObject. More...

Protected Member Functions inherited from ramses::ClientObject
	ClientObject (ClientObjectImpl &pimpl)
	Constructor for ClientObject. More...

virtual	~ClientObject ()
	Destructor of the ClientObject. More...

Protected Member Functions inherited from ramses::RamsesObject
	RamsesObject (RamsesObjectImpl &pimpl)
	Constructor for RamsesObject. More...

virtual	~RamsesObject ()
	Destructor of the RamsesObject. More...

Protected Member Functions inherited from ramses::StatusObject
	StatusObject (StatusObjectImpl &pimpl)
	Constructor for StatusObject. More...

virtual	~StatusObject ()
	Destructor of the StatusObject. More...

Friends
class	SceneImpl
	Scene is the factory for creating RenderBuffer instances. More...

Detailed Description

RenderBuffer can be used with RenderTarget as buffer for writing or with TextureSampler as buffer for reading.

A RenderBuffer can be used by one or more RenderTargets for rendering content into it. There are two basic types of RenderBuffers - color and depth, depth buffer can have additionally stencil data. A RenderBuffer can be used by one or more TextureSamplers for sampling data from it in a shader.

Examples: ramses-example-basic-rendertarget/src/main.cpp, ramses-example-local-offscreenbuffer/src/main.cpp, and ramses-example-renderonce/src/main.cpp.

Constructor & Destructor Documentation

◆ RenderBuffer()

ramses::RenderBuffer::RenderBuffer ( RenderBufferImpl & pimpl )

explicitprotected

Constructor for RenderBuffer.

Parameters

[in] pimpl Internal data for implementation specifics of RenderBuffer (sink - instance becomes owner)

◆ ~RenderBuffer()

virtual ramses::RenderBuffer::~RenderBuffer ( )

protectedvirtual

Destructor of the RenderBuffer.

Member Function Documentation

◆ getAccessMode()

ERenderBufferAccessMode ramses::RenderBuffer::getAccessMode ( ) const

Returns the read/write access mode of the RenderBuffer.

Returns: RenderBuffer access mode

◆ getBufferFormat()

ERenderBufferFormat ramses::RenderBuffer::getBufferFormat ( ) const

Returns the data format of the RenderBuffer.

Returns: RenderBuffer data format

◆ getBufferType()

ERenderBufferType ramses::RenderBuffer::getBufferType ( ) const

Returns the type of the RenderBuffer.

Returns: RenderBuffer type (color, depth, depth/stencil)

◆ getHeight()

uint32_t ramses::RenderBuffer::getHeight ( ) const

Returns the height of the RenderBuffer in pixels.

Returns: height in pixels

◆ getSampleCount()

uint32_t ramses::RenderBuffer::getSampleCount ( ) const

Returns the sample count used for MSAA.

Returns: RenderBuffer sample count

◆ getWidth()

uint32_t ramses::RenderBuffer::getWidth ( ) const

Returns the width of the RenderBuffer in pixels.

Returns: width in pixels

Friends And Related Function Documentation

◆ SceneImpl

friend class SceneImpl

friend

Scene is the factory for creating RenderBuffer instances.

Member Data Documentation

◆ impl

class RenderBufferImpl& ramses::RenderBuffer::impl

Stores internal data for implementation specifics of RenderBuffer.

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

/home/runner/work/ramses/ramses/client/ramses-client/ramses-client-api/include/ramses-client-api/RenderBuffer.h

Public Member Functions

Public Attributes

Protected Member Functions

Friends