StreamTexture is a special kind of texture, which holds a reference to a "fallback texture" and a stream source id. The content of the StreamTexture is dynamic and is determined within the renderer, based on whether the stream with the specified id is available or not. If it is available, the content of the StreamTexture is taken from the stream. Otherwise, the StreamTexture is replaced by the "fallback texture". More...

#include <StreamTexture.h>

Inheritance diagram for ramses::StreamTexture:

[legend]

Collaboration diagram for ramses::StreamTexture:

[legend]

Public Member Functions
status_t	forceFallbackImage (bool forceFallbackImage)
	Force usage of fallback texture even if compositing source is available. More...

bool	getForceFallbackImage () const
	Get the current value, if fallback image is forced or not. More...

waylandIviSurfaceId_t	getStreamSourceId () const
	Get the stream source id used for compositing on the stream texture. 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 StreamTextureImpl &	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
	StreamTexture (StreamTextureImpl &impl)
	Constructor of StreamTexture. More...

virtual	~StreamTexture ()
	Destructor of the StreamTexture. 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
	RamsesClient is the factory for creating StreamTexture instances. More...

Detailed Description

StreamTexture is a special kind of texture, which holds a reference to a "fallback texture" and a stream source id. The content of the StreamTexture is dynamic and is determined within the renderer, based on whether the stream with the specified id is available or not. If it is available, the content of the StreamTexture is taken from the stream. Otherwise, the StreamTexture is replaced by the "fallback texture".

Examples: ramses-example-basic-compositing/src/main.cpp, and ramses-example-local-dma-offscreenbuffer/src/main.cpp.

Constructor & Destructor Documentation

◆ StreamTexture()

ramses::StreamTexture::StreamTexture ( StreamTextureImpl & impl )

explicitprotected

Constructor of StreamTexture.

Parameters

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

◆ ~StreamTexture()

virtual ramses::StreamTexture::~StreamTexture ( )

protectedvirtual

Destructor of the StreamTexture.

Member Function Documentation

◆ forceFallbackImage()

status_t ramses::StreamTexture::forceFallbackImage ( bool forceFallbackImage )

Force usage of fallback texture even if compositing source is available.

Parameters

[in] forceFallbackImage If set to true the fallback image will always be shown even if streaming source for embedded compositing is or becomes available

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

◆ getForceFallbackImage()

bool ramses::StreamTexture::getForceFallbackImage ( ) const

Get the current value, if fallback image is forced or not.

Returns: If forcing of fallback image is currently enabled or not.

◆ getStreamSourceId()

waylandIviSurfaceId_t ramses::StreamTexture::getStreamSourceId ( ) const

Get the stream source id used for compositing on the stream texture.

Returns: Stream source id

Friends And Related Function Documentation

◆ SceneImpl

friend class SceneImpl

friend

RamsesClient is the factory for creating StreamTexture instances.

Member Data Documentation

◆ impl

class StreamTextureImpl& ramses::StreamTexture::impl

Stores internal data for implementation specifics of StreamTexture.

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

Public Member Functions

Public Attributes

Protected Member Functions

Friends