Texture represents a 2-D texture resource. More...

#include <Texture2D.h>

Inheritance diagram for ramses::Texture2D:

Collaboration diagram for ramses::Texture2D:

Public Member Functions
uint32_t	getWidth () const
	Gets texture width. More...

uint32_t	getHeight () const
	Gets texture height. More...

ETextureFormat	getTextureFormat () const
	Gets texture format. More...

const TextureSwizzle &	getTextureSwizzle () const
	Gets swizzle description. 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 Texture2DImpl &	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
	Texture2D (Texture2DImpl &pimpl)
	Constructor of Texture. More...

virtual	~Texture2D ()
	Destructor of the Texture. 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 Texture instances. More...

Detailed Description

Texture represents a 2-D texture resource.

Examples: ramses-example-basic-compositing/src/main.cpp, ramses-example-basic-file-loading/src/main.cpp, ramses-example-basic-texturing/src/main.cpp, ramses-example-dcsm-provider/src/main.cpp, ramses-example-local-client-dcsm/src/main.cpp, ramses-example-local-datalink/src/main.cpp, ramses-example-local-dma-offscreenbuffer/src/main.cpp, and ramses-example-local-offscreenbuffer/src/main.cpp.

Constructor & Destructor Documentation

◆ Texture2D()

ramses::Texture2D::Texture2D ( Texture2DImpl & pimpl )

explicitprotected

Constructor of Texture.

Parameters

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

◆ ~Texture2D()

virtual ramses::Texture2D::~Texture2D ( )

protectedvirtual

Destructor of the Texture.

Member Function Documentation

◆ getHeight()

uint32_t ramses::Texture2D::getHeight ( ) const

Gets texture height.

Returns: Texture height

◆ getTextureFormat()

ETextureFormat ramses::Texture2D::getTextureFormat ( ) const

Gets texture format.

Returns: Texture format

◆ getTextureSwizzle()

const TextureSwizzle& ramses::Texture2D::getTextureSwizzle ( ) const

Gets swizzle description.

Returns: Swizzle Description

◆ getWidth()

uint32_t ramses::Texture2D::getWidth ( ) const

Gets texture width.

Returns: Texture width

Friends And Related Function Documentation

◆ SceneImpl

friend class SceneImpl

friend

Scene is the factory for creating Texture instances.

Member Data Documentation

◆ impl

class Texture2DImpl& ramses::Texture2D::impl

Stores internal data for implementation specifics of Texture.

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

Public Member Functions

Public Attributes

Protected Member Functions

Friends