Skip to content
On this page

class ShaderParameterSampler

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

Properties

PropertyDescription
NameThe name of the ShaderParameterSampler object. (Inherited from Object)
SamplerStateThe name of the spShaderParameterSamplerState to use to override default sampler setting when setting up this sampler.
TextureFormatThe format of the texture object type, as exposed to the shader. Note that this will not modify the contents of the texture, only modify the type which is exposed in the shader. Only a subset of the types are allowed, and is shader language specific, and is exposed differently in HLSL vs GLSL. In general, 4-vector components of signed and unsigned ints, as well as floats are always allowed.
TextureNameThe name of the texture bound to the sampler. This name is used for lookup in the texture table.

Methods

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetClassGet the name of the ShaderParameterSampler class. (Inherited from Object)
IsAReturns true if ShaderParameterSampler is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the ShaderParameterSampler object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the ShaderParameterSampler object is valid. (Inherited from Object)
NonNullReturns true if the ShaderParameterSampler object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the ShaderParameterSampler object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast 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)

SamplerState

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

TextureFormat

The format of the texture object type, as exposed to the shader. Note that this will not modify the contents of the texture, only modify the type which is exposed in the shader. Only a subset of the types are allowed, and is shader language specific, and is exposed differently in HLSL vs GLSL. In general, 4-vector components of signed and unsigned ints, as well as floats are always allowed.

TextureName

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

Methods details

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 details

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)