Manage the properties, settings, and parameters to use for a specific Texture Asset. A sampler basically creates a bridge between the local texture definition and the one maintained in GPU memory.

See Also

Asset, Texture, Graphics

Static Variables

Name	Description
`asset`	Parent Asset where the Sampler is defined.
Declaration Asset *asset
`target`	Specifies the TextureTarget of the active Sampler.
Declaration TextureTarget target Note The target defines the type of Texture that is maintained on the GPU.
`texture_id`	Unique Texture id maintained by the GPU.
Declaration unsigned int texture_id
`internal_format`	Specifies the internal format of the Texture uploaded on GPU.
Declaration unsigned int internal_format
`format`	Specifies the format of the Texture uploaded on GPU.
Declaration unsigned int format
`type`	Specifies the data type of the Texmap data.
Declaration unsigned int type

Variables

Name	Description
`wrap_r`	Specifies the WrapMode to use on the `Z` axis.
Declaration WrapMode wrap_r Note Only available when the TextureTarget is either `kTexture3D` or `kTexture2DArray`.
`wrap_s`	Specifies the WrapMode to use on the `X` axis.
Declaration WrapMode wrap_s Note Apply to all TextureTarget types.
`wrap_t`	Specifies the WrapMode to use on the `Y` axis.
Declaration WrapMode wrap_t Note Apply to all TextureTarget types.
`filter_min`	The minifying Filter function to use whenever the texel being textured mapped is an area greater than one texture element.
Declaration Filter filter_min
`filter_mag`	The magnifying Filter function to use whenever the texel being textured mapped is less than or equal to an area to one texture element.
Declaration Filter filter_mag Warning Only `kNearest` or `kLinear` are valid Filter type to use for magnification.
`base_level`	Specifies the highest level of detail to use.
Declaration int base_level Warning Only available when the Sampler is using mipmaps.
`max_level`	Specifies the lowest level of detail to use.
Declaration int max_level Warning Only available when the Sampler is using mipmaps.
`anisotropy`	Specifies the anisotropic filtering factor to use on the various mipmap levels of the Sampler.
Declaration int anisotropy Warning Only available when the Sampler is using mipmaps.
`mip_level`	Amount of mip maps available in the Texmap texel data.
Declaration int mip_level Warning Only appy to compressed textures.

Functions

Name	Description
`Update`	Update and apply the new Sampler settings to its parent Texture.
Declaration void Update( void )
`Reload`	Manually reload the Sampler.
Declaration bool Reload( void ) Return Value `true` on success; else return `false` if the Sampler is not connected to an Asset, or if the Asset does not contain a valid Texture reference.

Filter

Available filtering types that can be applied on the various mipmap level the Sampler may contain (either for minification or magnification of the texel samples).

kNearest: Returns the value of the texture element that is nearest (in Manhattan distance) to the center of the pixel being textured.
kLinear: Returns the weighted average of the four texture elements that are closest to the center of the pixel being textured.
kNearestMipmapNearest: Chooses the mipmap that most closely matches the size of the pixel being textured and uses the kNearest criterion (the texture element nearest to the center of the pixel) to produce a texture value.
kLinearMipmapNearest: Chooses the mipmap that most closely matches the size of the pixel being textured and uses the kLinear criterion (a weighted average of the four texture elements that are closest to the center of the pixel) to produce a texture value.
kNearestMipmapLinear: Chooses the two mipmaps that most closely match the size of the pixel being textured and uses the kNearest criterion (the texture element nearest to the center of the pixel) to produce a texture value from each mipmap. The final texture value is a weighted average of those two values.
kLinearMipmapLinear: Chooses the two mipmaps that most closely match the size of the pixel being textured and uses the kLinear criterion (a weighted average of the four texture elements that are closest to the center of the pixel) to produce a texture value from each mipmap. The final texture value is a weighted average of those two values.

WrapMode

Defines the various strategies available when wrapping UVs.

kRepeat: Causes the integer part of the coordinate to be ignored.
kClampToEdge: Causes the coordinates to be clamped to the nearest Texture edge in the direction of clamping.
kMirroredRepeat: Causes the coordinate to be set to the fractional part of the Texture coordinate to be mirrored.