RenderTargetDescription holds all necessary information for a RenderTarget to be created. More...

#include <RenderTargetDescription.h>

Inheritance diagram for ramses::RenderTargetDescription:

Collaboration diagram for ramses::RenderTargetDescription:

Public Member Functions
	RenderTargetDescription ()
	Constructor of RenderTargetDescription. More...

status_t	addRenderBuffer (const RenderBuffer &renderBuffer)
	Adds a RenderBuffer to the RenderTargetDescription. 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 RenderTargetDescriptionImpl &	impl
	Stores internal data for implementation specifics of RenderTargetDescription. More...

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

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

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

Detailed Description

RenderTargetDescription holds all necessary information for a RenderTarget to be created.

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

◆ RenderTargetDescription()

ramses::RenderTargetDescription::RenderTargetDescription ( )

Constructor of RenderTargetDescription.

Member Function Documentation

◆ addRenderBuffer()

status_t ramses::RenderTargetDescription::addRenderBuffer ( const RenderBuffer & renderBuffer )

Adds a RenderBuffer to the RenderTargetDescription.

Multiple color RenderBuffers and at most one depth/stencil RenderBuffer can be added. The layout of multiple color RenderBuffers corresponds to the order of adding them (first RenderBuffer added has location 0, second added has location 1, etc.). Depth/stencil RenderBuffer is a special case and its relative order to the color buffer(s) irrelevant. All added render buffers must have same MSAA sample count. Trying to add render buffers with different sample count values will fail and generate error.

Parameters

[in] renderBuffer RenderBuffer to be added to the RenderTargetDescription.

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

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

Member Data Documentation

◆ impl

class RenderTargetDescriptionImpl& ramses::RenderTargetDescription::impl

Stores internal data for implementation specifics of RenderTargetDescription.

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/RenderTargetDescription.h

Public Member Functions

Public Attributes