The TextureSampler holds a texture and its sampling parameters. More...

#include <TextureSampler.h>

Inheritance diagram for ramses::TextureSampler:

Collaboration diagram for ramses::TextureSampler:

Public Member Functions
ETextureAddressMode	getWrapUMode () const
	Gets the texture wrap mode for the u axis. More...

ETextureAddressMode	getWrapVMode () const
	Gets the texture wrap mode for the v axis. More...

ETextureAddressMode	getWrapRMode () const
	Gets the texture wrap mode for the r axis. More...

ETextureSamplingMethod	getMinSamplingMethod () const
	Gets the texture min sampling method. More...

ETextureSamplingMethod	getMagSamplingMethod () const
	Gets the texture mag sampling method. More...

uint32_t	getAnisotropyLevel () const
	Gets the texture sampling anisotropy level. More...

ERamsesObjectType	getTextureType () const
	Gets the type of the texture. More...

status_t	setTextureData (const Texture2D &dataSource)
	Replaces current texture content source with a new one. Texture data can be changed from/to any type/format with these exceptions: More...

status_t	setTextureData (const Texture3D &dataSource)
	Replaces current texture content source with a new one. Texture data can be changed from/to any type/format with these exceptions: More...

status_t	setTextureData (const TextureCube &dataSource)
	Replaces current texture content source with a new one. Texture data can be changed from/to any type/format with these exceptions: More...

status_t	setTextureData (const Texture2DBuffer &dataSource)
	Replaces current texture content source with a new one. Texture data can be changed from/to any type/format with these exceptions: More...

status_t	setTextureData (const RenderBuffer &dataSource)
	Replaces current texture content source with a new one. Texture data can be changed from/to any type/format with these exceptions: More...

status_t	setTextureData (const StreamTexture &dataSource)
	Replaces current texture content source with a new one. Texture data can be changed from/to any type/format with these exceptions: 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 TextureSamplerImpl &	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
	TextureSampler (TextureSamplerImpl &pimpl)
	Constructor for TextureSampler. More...

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

Detailed Description

The TextureSampler holds a texture and its sampling parameters.

Examples: ramses-example-basic-compositing/src/main.cpp, ramses-example-basic-file-loading/src/main.cpp, ramses-example-basic-rendertarget/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-local-client-dcsm/src/main.cpp, ramses-example-local-datalink/src/main.cpp, ramses-example-local-dma-offscreenbuffer/src/main.cpp, ramses-example-local-offscreenbuffer/src/main.cpp, and ramses-example-renderonce/src/main.cpp.

Constructor & Destructor Documentation

◆ TextureSampler()

ramses::TextureSampler::TextureSampler ( TextureSamplerImpl & pimpl )

explicitprotected

Constructor for TextureSampler.

Parameters

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

◆ ~TextureSampler()

virtual ramses::TextureSampler::~TextureSampler ( )

protectedvirtual

Destructor of the TextureSampler.

Member Function Documentation

◆ getAnisotropyLevel()

uint32_t ramses::TextureSampler::getAnisotropyLevel ( ) const

Gets the texture sampling anisotropy level.

Returns: The texture sampling anisotropy level.

◆ getMagSamplingMethod()

ETextureSamplingMethod ramses::TextureSampler::getMagSamplingMethod ( ) const

Gets the texture mag sampling method.

Returns: ETextureSamplingMethod mag sampling method

◆ getMinSamplingMethod()

ETextureSamplingMethod ramses::TextureSampler::getMinSamplingMethod ( ) const

Gets the texture min sampling method.

Returns: ETextureSamplingMethod min sampling method

◆ getTextureType()

ERamsesObjectType ramses::TextureSampler::getTextureType ( ) const

Gets the type of the texture.

Returns: Type of the texture, see ERamsesObjectType enum for possible values.

◆ getWrapRMode()

ETextureAddressMode ramses::TextureSampler::getWrapRMode ( ) const

Gets the texture wrap mode for the r axis.

Returns: ETextureAddressMode wrap mode for r axis

◆ getWrapUMode()

ETextureAddressMode ramses::TextureSampler::getWrapUMode ( ) const

Gets the texture wrap mode for the u axis.

Returns: ETextureAddressMode wrap mode for u axis

◆ getWrapVMode()

ETextureAddressMode ramses::TextureSampler::getWrapVMode ( ) const

Gets the texture wrap mode for the v axis.

Returns: ETextureAddressMode wrap mode for v axis

◆ setTextureData() [1/6]

status_t ramses::TextureSampler::setTextureData ( const RenderBuffer & dataSource )

Replaces current texture content source with a new one. Texture data can be changed from/to any type/format with these exceptions:

◆ setTextureData() [2/6]

status_t ramses::TextureSampler::setTextureData ( const StreamTexture & dataSource )

Replaces current texture content source with a new one. Texture data can be changed from/to any type/format with these exceptions:

◆ setTextureData() [3/6]

status_t ramses::TextureSampler::setTextureData ( const Texture2D & dataSource )

Replaces current texture content source with a new one. Texture data can be changed from/to any type/format with these exceptions:

Texture3D can only be changed to another Texture3D
texture data cannot be changed if this TextureSampler is marked as texture consumer to be used for data linking (see ramses::Scene::createTextureConsumer)

Parameters

[in] dataSource Texture data source to be used with this sampler.

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

◆ setTextureData() [4/6]

status_t ramses::TextureSampler::setTextureData ( const Texture2DBuffer & dataSource )

Replaces current texture content source with a new one. Texture data can be changed from/to any type/format with these exceptions:

◆ setTextureData() [5/6]

status_t ramses::TextureSampler::setTextureData ( const Texture3D & dataSource )

Replaces current texture content source with a new one. Texture data can be changed from/to any type/format with these exceptions:

◆ setTextureData() [6/6]

status_t ramses::TextureSampler::setTextureData ( const TextureCube & dataSource )

Replaces current texture content source with a new one. Texture data can be changed from/to any type/format with these exceptions:

Friends And Related Function Documentation

◆ SceneImpl

friend class SceneImpl

friend

Scene is the factory for creating TextureSampler instances.

Member Data Documentation

◆ impl

class TextureSamplerImpl& ramses::TextureSampler::impl

Stores internal data for implementation specifics of TextureSampler.

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

Public Member Functions

Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ TextureSampler()

◆ ~TextureSampler()

Member Function Documentation

◆ getAnisotropyLevel()

◆ getMagSamplingMethod()

◆ getMinSamplingMethod()

◆ getTextureType()

◆ getWrapRMode()

◆ getWrapUMode()

◆ getWrapVMode()

◆ setTextureData() [1/6]

◆ setTextureData() [2/6]

◆ setTextureData() [3/6]

◆ setTextureData() [4/6]

◆ setTextureData() [5/6]

◆ setTextureData() [6/6]

Friends And Related Function Documentation

◆ SceneImpl

Member Data Documentation

◆ impl