ramses::EffectInput Class Reference

The EffectInput is a description of an effect input. More...

#include <EffectInput.h>

Inheritance diagram for ramses::EffectInput:

Collaboration diagram for ramses::EffectInput:

Public Member Functions
virtual	~EffectInput ()
	Destructor of EffectInput. More...
const char *	getName () const
	Returns the name of the effect input. More...
bool	isValid () const
	Returns the state of the EffectInput object. 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 EffectInputImpl &	impl
Public Attributes inherited from ramses::StatusObject
class StatusObjectImpl &	impl

Protected Member Functions
	EffectInput (EffectInputImpl &effectInputImpl)
	Constructor of EffectInput. More...
Protected Member Functions inherited from ramses::StatusObject
	StatusObject (StatusObjectImpl &pimpl)
	Constructor for StatusObject. More...
virtual	~StatusObject ()
	Destructor of the StatusObject. More...

Detailed Description

The EffectInput is a description of an effect input.

Constructor & Destructor Documentation

~EffectInput()

virtual ramses::EffectInput::~EffectInput ( )

virtual

Destructor of EffectInput.

EffectInput()

ramses::EffectInput::EffectInput ( EffectInputImpl &  effectInputImpl )

explicitprotected

Constructor of EffectInput.

Parameters

[in]

effectInputImpl

Internal data for implementation specifics of EffectInput (sink - instance becomes owner)

Member Function Documentation

getName()

const char* ramses::EffectInput::getName

(

)

const

Returns the name of the effect input.

Returns

Name of the effect input

Examples

ramses-example-local-offscreenbuffer/src/main.cpp.

isValid()

bool ramses::EffectInput::isValid

(

)

const

Returns the state of the EffectInput object.

Returns

Returns true if this EffectInput object is initialized and refers to an existing effect input

Member Data Documentation

impl

class EffectInputImpl& ramses::EffectInput::impl

Stores internal data for implementation specifics of EffectInput.

---

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