The SceneConfig holds a set of parameters to be used when creating a scene. More...

#include <SceneConfig.h>

Inheritance diagram for ramses::SceneConfig:

Collaboration diagram for ramses::SceneConfig:

Public Member Functions
	SceneConfig ()
	Empty constructor of SceneConfig - has default values. More...

	SceneConfig (const SceneConfig &other)
	Copy constructor of SceneConfig. More...

virtual	~SceneConfig ()
	Destructor of SceneConfig. More...

status_t	setPublicationMode (EScenePublicationMode publicationMode)
	Set the publication mode that will be used for this scene. 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 SceneConfigImpl &	impl

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

The SceneConfig holds a set of parameters to be used when creating a scene.

Examples: ramses-example-basic-animation-realtime/src/main.cpp, ramses-example-basic-animation/src/main.cpp, ramses-example-basic-blending/src/main.cpp, ramses-example-basic-effect-from-glsl/src/main.cpp, ramses-example-basic-file-loading/src/main.cpp, ramses-example-basic-geometry/src/main.cpp, ramses-example-basic-rendergroups/src/main.cpp, ramses-example-basic-renderpasses/src/main.cpp, ramses-example-basic-rendertarget/src/main.cpp, ramses-example-basic-scenegraph/src/main.cpp, ramses-example-basic-texturing/src/main.cpp, ramses-example-data-buffers-texture/src/main.cpp, ramses-example-data-buffers-vertices/src/main.cpp, ramses-example-dcsm-provider/src/main.cpp, ramses-example-geometry-instancing/src/main.cpp, ramses-example-interleaved-vertex-buffers/src/main.cpp, ramses-example-local-client-dcsm/src/main.cpp, ramses-example-local-client/src/main.cpp, ramses-example-local-datalink/src/main.cpp, ramses-example-local-displays/src/main.cpp, ramses-example-local-dma-offscreenbuffer/src/main.cpp, ramses-example-local-geometry-shaders/src/main.cpp, ramses-example-local-offscreenbuffer/src/main.cpp, ramses-example-local-pick-handling/src/main.cpp, and ramses-example-renderonce/src/main.cpp.

Constructor & Destructor Documentation

◆ SceneConfig() [1/2]

ramses::SceneConfig::SceneConfig ( )

Empty constructor of SceneConfig - has default values.

◆ SceneConfig() [2/2]

ramses::SceneConfig::SceneConfig ( const SceneConfig & other )

Copy constructor of SceneConfig.

Parameters

[in] other Other instance of SceneConfig

◆ ~SceneConfig()

virtual ramses::SceneConfig::~SceneConfig ( )

virtual

Destructor of SceneConfig.

Member Function Documentation

◆ setPublicationMode()

status_t ramses::SceneConfig::setPublicationMode ( EScenePublicationMode publicationMode )

Set the publication mode that will be used for this scene.

Later calls to publish must use the same value as given here. Setting this to EScenePublicationMode_LocalOnly for scenes that will never be published remotely enables optimization possibilities.

Parameters

[in] publicationMode Publication mode to use with scene.

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

Member Data Documentation

◆ impl

class SceneConfigImpl& ramses::SceneConfig::impl

Stores internal data for implementation specifics of SceneConfig.

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

Public Member Functions

Public Attributes

Additional Inherited Members