# `class` ShaderParameterSampler

ShaderParameterSampler defines a sampler used by the evaluation shader to sample data from a specified texture.

# Properties

Property	Description
Name	The name of the ShaderParameterSampler object. (Inherited from Object)
SamplerState	The name of the spShaderParameterSamplerState to use to override default sampler setting when setting up this sampler.
TextureName	The name of the texture bound to the sampler. This name is used for lookup in the texture table.

# Methods

Method	Description
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetClass	Get the name of the ShaderParameterSampler class. (Inherited from Object)
IsA	Returns true if ShaderParameterSampler is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the ShaderParameterSampler object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the ShaderParameterSampler object is valid. (Inherited from Object)
NonNull	Returns true if the ShaderParameterSampler object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the ShaderParameterSampler object to the log. (Inherited from Object)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)

# Static methods

Method	Description
IsClassA	Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast	SafeCast makes sure the input object is of a class that can be cast into spShaderParameterSampler, and if this is the case, returns the object cast into spShaderParameterSampler. (Inherited from Object)

# Properties details

# Name

The name of the ShaderParameterSampler object. (Inherited from Object)

# Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

# SetName parameters

Type	Name	Min	Max	Description
`const char *`	name			New name of the object.

# GetName return value

Type: spString

Type	Name	Min	Max	Description
`string`	name			New name of the object.

Name	Type	Min	Max	Description
name	`str`			New name of the object.

# SamplerState

The name of the spShaderParameterSamplerState to use to override default sampler setting when setting up this sampler.

# Syntax

// Setter
void SetSamplerState( const char * value ) const;

// Getter
spString GetSamplerState() const;

# SetSamplerState parameters

Type	Name	Min	Max	Description
`const char *`	value			The desired spShaderParameterSamplerState name.

# GetSamplerState return value

Type: spString

Type	Name	Min	Max	Description
`string`	value			The desired spShaderParameterSamplerState name.

Name	Type	Min	Max	Description
value	`str`			The desired spShaderParameterSamplerState name.

# TextureName

The name of the texture bound to the sampler. This name is used for lookup in the texture table.

# Syntax

// Setter
void SetTextureName( const char * value ) const;

// Getter
spString GetTextureName() const;

# SetTextureName parameters

Type	Name	Min	Max	Description
`const char *`	value			The desired texture name.

# GetTextureName return value

Type: spString

Type	Name	Min	Max	Description
`string`	value			The desired texture name.

Name	Type	Min	Max	Description
value	`str`			The desired texture name.

# Methods details

# AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

# Syntax

rid AddObserver( const spObserver & observer ) const;

# Parameters

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

# Return value

Type: rid

Name	Type	Min	Max	Description
observer	`Observer`			Observer is the object that will receive events.

# GetClass

Get the name of the ShaderParameterSampler class. (Inherited from Object)

# Syntax

spString GetClass() const;

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# IsA

Returns true if ShaderParameterSampler is a or is a descendant of the class named as the type parameter. (Inherited from Object)

# Syntax

bool IsA( const char * type ) const;

# Parameters

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if ShaderParameterSampler is, or is a descendant of.

# Return value

Type: bool

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if ShaderParameterSampler is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if ShaderParameterSampler is, or is a descendant of.

# IsNull

Returns true if the ShaderParameterSampler object is invalid. (Inherited from Object)

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

Returns true if the ShaderParameterSampler object is valid. (Inherited from Object)

# Syntax

bool IsSameObjectAs( const spObject & object ) const;

# Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

# Return value

Type: bool

Name	Type	Min	Max	Description
object	Object			Object to compare with.

# NonNull

Returns true if the ShaderParameterSampler object is valid. (Inherited from Object)

# Syntax

bool NonNull() const;

# Parameters

NonNull takes no parameters.

# Return value

Type: bool

# PrintInfo

Prints the content/info of the ShaderParameterSampler object to the log. (Inherited from Object)

# Syntax

void PrintInfo() const;

# Parameters

PrintInfo takes no parameters.

# RemoveObserver

Removes a previously added observer object. (Inherited from Object)

# Syntax

void RemoveObserver( rid observerId ) const;

# Parameters

Type	Name	Min	Max	Description
`rid`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Type	Name	Min	Max	Description
`int`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Name	Type	Min	Max	Description
observerId	`int`			ObserverId is the id returned by AddObserver when the observer was added.

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

# Syntax

static bool IsClassA( const char * type ) const;

# Parameters

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if the class is, or is a descendant of.

# Return value

Type: bool

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if the class is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if the class is, or is a descendant of.

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spShaderParameterSampler, and if this is the case, returns the object cast into spShaderParameterSampler. (Inherited from Object)

# Syntax

static spShaderParameterSampler SafeCast( const spObject & object ) const;

# Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

# Return value

Type: ShaderParameterSampler

Name	Type	Min	Max	Description
object	Object			Object to cast.

← ShaderParameterBuffer ShaderParameterSamplerState →

# class ShaderParameterSampler

# Properties

# Methods

# Static methods

# Properties details

# Name

# Syntax

# SetName parameters

# GetName return value

# SamplerState

# Syntax

# SetSamplerState parameters

# GetSamplerState return value

# TextureName

# Syntax

# SetTextureName parameters

# GetTextureName return value

# Methods details

# AddObserver

# Syntax

# Parameters

# Return value

# GetClass

# Syntax

# Parameters

# Return value

# IsA

# Syntax

# Parameters

# Return value

# IsNull

# Syntax

# Parameters

# Return value

# IsSameObjectAs

# Syntax

# Parameters

# Return value

# NonNull

# Syntax

# Parameters

# Return value

# PrintInfo

# Syntax

# Parameters

# RemoveObserver

# Syntax

# Parameters

# Static methods details

# IsClassA

# Syntax

# Parameters

# Return value

# SafeCast

# Syntax

# Parameters

# Return value

# `class` ShaderParameterSampler