ramses::ArrayResource Class Reference

The ArrayResource stores a data array of a given type. The data is immutable. The resource can be used as input for a ramses::GeometryBinding. More...

#include <ArrayResource.h>

Inheritance diagram for ramses::ArrayResource:

Collaboration diagram for ramses::ArrayResource:

Public Member Functions
uint32_t	getNumberOfElements () const
	Returns number of elements of the array. More...
EDataType	getDataType () const
	Returns the data type of the data array. More...
Public Member Functions inherited from ramses::Resource
resourceId_t	getResourceId () const
	Get resource Id. 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 ArrayResourceImpl &	impl
Public Attributes inherited from ramses::Resource
class ResourceImpl &	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
	ArrayResource (ArrayResourceImpl &pimpl)
	Constructor of ArrayResource. More...
	ArrayResource (const ArrayResource &other)
	Copy constructor of ArrayResource. More...
ArrayResource &	operator= (const ArrayResource &other)
	Assignment operator of ArrayResource. More...
virtual	~ArrayResource ()
	Destructor of the ArrayResource. More...
Protected Member Functions inherited from ramses::Resource
	Resource (ResourceImpl &pimpl)
	Constructor for Resource. More...
virtual	~Resource ()
	Destructor for Resource. 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
	Scene is the factory for creating ArrayResource instances. More...

Detailed Description

The ArrayResource stores a data array of a given type. The data is immutable. The resource can be used as input for a ramses::GeometryBinding.

If an ArrayResource object is created with type ramses::EDataType::ByteBlob then an element is defined as one byte, rather than a logical vertex element. Hence, number of elements is the same as size in bytes.

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-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-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

ArrayResource() [1/2]

ramses::ArrayResource::ArrayResource ( ArrayResourceImpl &  pimpl )

explicitprotected

Constructor of ArrayResource.

Parameters

[in]

pimpl

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

ArrayResource() [2/2]

ramses::ArrayResource::ArrayResource ( const ArrayResource &  other )

protected

Copy constructor of ArrayResource.

Parameters

[in]

other

Other instance of ArrayResource class

~ArrayResource()

virtual ramses::ArrayResource::~ArrayResource ( )

protectedvirtual

Destructor of the ArrayResource.

Member Function Documentation

getDataType()

EDataType ramses::ArrayResource::getDataType

(

)

const

Returns the data type of the data array.

getNumberOfElements()

uint32_t ramses::ArrayResource::getNumberOfElements

(

)

const

Returns number of elements of the array.

operator=()

ArrayResource& ramses::ArrayResource::operator= ( const ArrayResource &  other )

protected

Assignment operator of ArrayResource.

Parameters

[in]

other

Other instance of ArrayResource class

Returns

This instance after assignment

Friends And Related Function Documentation

SceneImpl

friend class SceneImpl

friend

Scene is the factory for creating ArrayResource instances.

Member Data Documentation

impl

class ArrayResourceImpl& ramses::ArrayResource::impl

Stores internal data for implementation specifics of ArrayResource.

---

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