RAMSES Documentation  27.0.130
Information for RAMSES users and developers
Public Member Functions | List of all members
ramses::UniformInput Class Reference

The UniformInput is a description of an uniform effect input. More...

#include <UniformInput.h>

Inheritance diagram for ramses::UniformInput:
[legend]
Collaboration diagram for ramses::UniformInput:
[legend]

Public Member Functions

 UniformInput ()
 Constructor of UniformInput. More...
 
EEffectInputDataType getDataType () const
 Returns the effect input data type. More...
 
EEffectUniformSemantic getSemantics () const
 Returns the effect input semantics. More...
 
uint32_t getElementCount () const
 Returns the number of elements that are assigned to this effect input. More...
 
- Public Member Functions inherited from ramses::EffectInput
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...
 
StatusObjectoperator= (const StatusObject &other)=delete
 Deleted copy assignment. More...
 

Additional Inherited Members

- Public Attributes inherited from ramses::EffectInput
class EffectInputImpl & impl
 
- Public Attributes inherited from ramses::StatusObject
class StatusObjectImpl & impl
 
- Protected Member Functions inherited from ramses::EffectInput
 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 UniformInput is a description of an uniform effect input.

Examples
ramses-example-basic-animation/src/main.cpp, ramses-example-basic-blending/src/main.cpp, ramses-example-basic-compositing/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-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, ramses-example-local-scene-referencing/src/main.cpp, ramses-example-local-viewport-link/src/main.cpp, and ramses-example-renderonce/src/main.cpp.

Constructor & Destructor Documentation

◆ UniformInput()

ramses::UniformInput::UniformInput ( )

Constructor of UniformInput.

Member Function Documentation

◆ getDataType()

EEffectInputDataType ramses::UniformInput::getDataType ( ) const

Returns the effect input data type.

Returns
Effect input data type

◆ getElementCount()

uint32_t ramses::UniformInput::getElementCount ( ) const

Returns the number of elements that are assigned to this effect input.

Returns
the element count or 0 if not initialized

◆ getSemantics()

EEffectUniformSemantic ramses::UniformInput::getSemantics ( ) const

Returns the effect input semantics.

Returns
Effect input semantics

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