`class` ShaderParameterSamplerState

ShaderParameterSamplerState defines a named sampler state that override default sampler state and can be shared between multiple spShaderParameterSampler's.

Properties

Property	Description
AddressU	The addressing mode for U coordinate outside of [0,1)
AddressV	The addressing mode for V coordinate outside of [0,1)
AddressW	The addressing mode for W coordinate outside of [0,1)
MagFilter	The magnification filter to apply to texture lookups.
MinFilter	The minification filter to apply to texture lookups.
Name	The name of the ShaderParameterSamplerState object. (Inherited from Object)
UnNormalizedCoordinates	The flag controls weather texture coordinates are normalized or not. If set to true the allowed coordinate range is zero to image. If set to false range is zero to one. Is false by default.

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 ShaderParameterSamplerState class. (Inherited from Object)
IsA	Returns true if ShaderParameterSamplerState is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the ShaderParameterSamplerState object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the ShaderParameterSamplerState object is valid. (Inherited from Object)
NonNull	Returns true if the ShaderParameterSamplerState object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the ShaderParameterSamplerState 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 spShaderParameterSamplerState, and if this is the case, returns the object cast into spShaderParameterSamplerState. (Inherited from Object)

Properties details

AddressU

The addressing mode for U coordinate outside of [0,1)

Type	Name	Min	Max	Description
ESamplerAddressMode	value			The desired addressing mode for U coordinate.

Key	Value	Comment
Repeat	0	Repeat wrap mode.
MirrorRepeat	1	Repeat wrap mode with mirroring.
ClampToBorder	2	Clamp to border wrap mode will be used.
ClampToEdge	3	Clamp to edge wrap mode will be used.

Type	Name	Min	Max	Description
ESamplerAddressMode	value			The desired addressing mode for U coordinate.

Key	Value	Comment
Repeat	0	Repeat wrap mode.
MirrorRepeat	1	Repeat wrap mode with mirroring.
ClampToBorder	2	Clamp to border wrap mode will be used.
ClampToEdge	3	Clamp to edge wrap mode will be used.

Name	Type	Min	Max	Description
value	ESamplerAddressMode			The desired addressing mode for U coordinate.

Key	Value	Comment
ESamplerAddressMode_Repeat	0	Repeat wrap mode.
ESamplerAddressMode_MirrorRepeat	1	Repeat wrap mode with mirroring.
ESamplerAddressMode_ClampToBorder	2	Clamp to border wrap mode will be used.
ESamplerAddressMode_ClampToEdge	3	Clamp to edge wrap mode will be used.

AddressV

The addressing mode for V coordinate outside of [0,1)

Type	Name	Min	Max	Description
ESamplerAddressMode	value			The desired addressing mode for V coordinate.

Key	Value	Comment
Repeat	0	Repeat wrap mode.
MirrorRepeat	1	Repeat wrap mode with mirroring.
ClampToBorder	2	Clamp to border wrap mode will be used.
ClampToEdge	3	Clamp to edge wrap mode will be used.

Type	Name	Min	Max	Description
ESamplerAddressMode	value			The desired addressing mode for V coordinate.

Key	Value	Comment
Repeat	0	Repeat wrap mode.
MirrorRepeat	1	Repeat wrap mode with mirroring.
ClampToBorder	2	Clamp to border wrap mode will be used.
ClampToEdge	3	Clamp to edge wrap mode will be used.

Name	Type	Min	Max	Description
value	ESamplerAddressMode			The desired addressing mode for V coordinate.

Key	Value	Comment
ESamplerAddressMode_Repeat	0	Repeat wrap mode.
ESamplerAddressMode_MirrorRepeat	1	Repeat wrap mode with mirroring.
ESamplerAddressMode_ClampToBorder	2	Clamp to border wrap mode will be used.
ESamplerAddressMode_ClampToEdge	3	Clamp to edge wrap mode will be used.

AddressW

The addressing mode for W coordinate outside of [0,1)

Type	Name	Min	Max	Description
ESamplerAddressMode	value			The desired addressing mode for W coordinate.

Key	Value	Comment
Repeat	0	Repeat wrap mode.
MirrorRepeat	1	Repeat wrap mode with mirroring.
ClampToBorder	2	Clamp to border wrap mode will be used.
ClampToEdge	3	Clamp to edge wrap mode will be used.

Type	Name	Min	Max	Description
ESamplerAddressMode	value			The desired addressing mode for W coordinate.

Key	Value	Comment
Repeat	0	Repeat wrap mode.
MirrorRepeat	1	Repeat wrap mode with mirroring.
ClampToBorder	2	Clamp to border wrap mode will be used.
ClampToEdge	3	Clamp to edge wrap mode will be used.

Name	Type	Min	Max	Description
value	ESamplerAddressMode			The desired addressing mode for W coordinate.

Key	Value	Comment
ESamplerAddressMode_Repeat	0	Repeat wrap mode.
ESamplerAddressMode_MirrorRepeat	1	Repeat wrap mode with mirroring.
ESamplerAddressMode_ClampToBorder	2	Clamp to border wrap mode will be used.
ESamplerAddressMode_ClampToEdge	3	Clamp to edge wrap mode will be used.

MagFilter

The magnification filter to apply to texture lookups.

Type	Name	Min	Max	Description
ESamplerFilter	value			The desired magnification value.

Key	Value	Comment
Nearest	0	Automatic detection.
Linear	1	Manual detection.

Type	Name	Min	Max	Description
ESamplerFilter	value			The desired magnification value.

Key	Value	Comment
Nearest	0	Automatic detection.
Linear	1	Manual detection.

Name	Type	Min	Max	Description
value	ESamplerFilter			The desired magnification value.

Key	Value	Comment
ESamplerFilter_Nearest	0	Automatic detection.
ESamplerFilter_Linear	1	Manual detection.

MinFilter

The minification filter to apply to texture lookups.

Type	Name	Min	Max	Description
ESamplerFilter	value			The desired magnification value.

Key	Value	Comment
Nearest	0	Automatic detection.
Linear	1	Manual detection.

Type	Name	Min	Max	Description
ESamplerFilter	value			The desired magnification value.

Key	Value	Comment
Nearest	0	Automatic detection.
Linear	1	Manual detection.

Name	Type	Min	Max	Description
value	ESamplerFilter			The desired magnification value.

Key	Value	Comment
ESamplerFilter_Nearest	0	Automatic detection.
ESamplerFilter_Linear	1	Manual detection.

Name

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

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

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

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

UnNormalizedCoordinates

The flag controls weather texture coordinates are normalized or not. If set to true the allowed coordinate range is zero to image. If set to false range is zero to one. Is false by default.

Type	Name	Min	Max	Description
`bool`	value			The desired flag value.

Type	Name	Min	Max	Description
`bool`	value			The desired flag value.

Name	Type	Min	Max	Description
value	`bool`			The desired flag value.

Methods details

AddObserver

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

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

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

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

GetClass

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

IsA

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

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

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

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

IsNull

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

IsSameObjectAs

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

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

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

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

NonNull

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

PrintInfo

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

RemoveObserver

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

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.

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 spShaderParameterSamplerState, and if this is the case, returns the object cast into spShaderParameterSamplerState. (Inherited from Object)

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class ShaderParameterSamplerState ​

Properties ​

Methods ​

Static methods ​

Properties details ​

AddressU ​

AddressV ​

AddressW ​

MagFilter ​

MinFilter ​

Name ​

UnNormalizedCoordinates ​

Methods details ​

AddObserver ​

GetClass ​

IsA ​