core::data::sampler_t class final

describes the data to build a core::ivk::sampler_t instance

member-functions

mipmaps

returns if mipmapping is enabled or not

const public

mipmaps

const public

returns

bool

description

returns if mipmapping is enabled or not

mipmaps

enables or disables mipmapping on this sampler.

public

mipmaps

public

returns

void

value

bool

description

enables or disables mipmapping on this sampler.

mip_bias

returns the mip_bias that might be present on this sampler.

const public

mip_bias

const public

returns

float

description

returns the mip_bias that might be present on this sampler.

mip_bias

sets the mip bias when sampling mipmaps.

public

mip_bias

public

returns

void

value

float

description

sets the mip bias when sampling mipmaps.

mip_mode

returns the mode for mipmap texture lookups.

const public

mip_mode

const public

returns

core::gfx::sampler_mipmap_mode

description

returns the mode for mipmap texture lookups.

mip_mode

sets the mode for mipmap texture lookups.

public

mip_mode

public

returns

void

value

core::gfx::sampler_mipmap_mode

description

sets the mode for mipmap texture lookups.

mip_minlod

returns the minimal mipmap LOD this instance has set.

const public

mip_minlod

const public

returns

float

description

returns the minimal mipmap LOD this instance has set.

mip_minlod

sets the minimal mipmap LOD offset for this instance.

public

mip_minlod

public

returns

void

value

float

description

sets the minimal mipmap LOD offset for this instance.

mip_maxlod

returns the max mipmap LOD this instance has set.

const public

mip_maxlod

const public

returns

float

description

returns the max mipmap LOD this instance has set.

mip_maxlod

sets the minimal mipmap max LOD for this instance.

public

mip_maxlod

public

returns

void

value

float

description

sets the minimal mipmap max LOD for this instance.

addressU

returns how this instances deals with texture tiling in the U-axis.

const public

addressU

const public

returns

core::gfx::sampler_address_mode

description

returns how this instances deals with texture tiling in the U-axis.

addressU

sets how this instance should deal with texture tiling in the U-axis.

public

addressU

public

returns

void

value

core::gfx::sampler_address_mode

description

sets how this instance should deal with texture tiling in the U-axis.

addressV

returns how this instances deals with texture tiling in the V-axis.

const public

addressV

const public

returns

core::gfx::sampler_address_mode

description

returns how this instances deals with texture tiling in the V-axis.

addressV

sets how this instance should deal with texture tiling in the V-axis.

public

addressV

public

returns

void

value

core::gfx::sampler_address_mode

description

sets how this instance should deal with texture tiling in the V-axis.

addressW

returns how this instances deals with texture tiling in the W-axis.

const public

addressW

const public

returns

core::gfx::sampler_address_mode

description

returns how this instances deals with texture tiling in the W-axis.

addressW

sets how this instance should deal with texture tiling in the W-axis.

public

addressW

public

returns

void

value

core::gfx::sampler_address_mode

description

sets how this instance should deal with texture tiling in the W-axis.

border_color

returns the border color that will be used during texture lookups.

const public

border_color

const public

returns

core::gfx::border_color

description

returns the border color that will be used during texture lookups.

border_color

sets the border color that should be used during texture lookups.

public

border_color

public

returns

void

value

core::gfx::border_color

description

sets the border color that should be used during texture lookups.

anisotropic_filtering

returns if anisotropic filtering is enabled.

const public

anisotropic_filtering

const public

returns

bool

description

returns if anisotropic filtering is enabled.

anisotropic_filtering

call this to enable or disable anisotropic filtering.

public

anisotropic_filtering

public

returns

void

value

bool

description

call this to enable or disable anisotropic filtering.

max_anisotropy

returns the max anistropic value for this instance.

const public

max_anisotropy

const public

returns

float

description

returns the max anistropic value for this instance.

max_anisotropy

sets the max anistropic value for this instance.

public

max_anisotropy

public

returns

void

value

float

description

sets the max anistropic value for this instance.

compare_mode

returns if compare operations have been enabled or not.

const public

compare_mode

const public

returns

bool

description

returns if compare operations have been enabled or not.

compare_mode

enables or disables compare ops.

public

compare_mode

public

returns

void

value

bool

description

enables or disables compare ops.

compare_op

returns what compare op would be used if compare_mode() is true.

const public

compare_op

const public

returns

core::gfx::compare_op

description

returns what compare op would be used if compare_mode() is true.

compare_op

sets the compare op to a new value.

public

compare_op

public

returns

void

value

core::gfx::compare_op

description

sets the compare op to a new value.

filter_min

returns the filtering mode to use when dealing with minification.

const public

filter_min

const public

returns

core::gfx::filter

description

returns the filtering mode to use when dealing with minification.

filter_min

sets the filtering mode to use when dealing with minification.

public

filter_min

public

returns

void

value

core::gfx::filter

description

sets the filtering mode to use when dealing with minification.

filter_max

returns the filtering mode to use when dealing with magnification.

const public

filter_max

const public

returns

core::gfx::filter

description

returns the filtering mode to use when dealing with magnification.

filter_max

sets the filtering mode to use when dealing with magnification.

public

filter_max

public

returns

void

value

core::gfx::filter

description

sets the filtering mode to use when dealing with magnification.

normalized_coordinates

returns if the coordinates for this sampler will be normalized or not.

const public

normalized_coordinates

const public

returns

bool

description

returns if the coordinates for this sampler will be normalized or not.

normalized_coordinates

enables or disables coordinate normalization when this sampler is used.

public

normalized_coordinates

public

returns

void

value

bool

description

enables or disables coordinate normalization when this sampler is used.

Function documentation

bool core::data::sampler_t::mipmaps() const

Brief

returns if mipmapping is enabled or not

Returns	if mipmapping is enabled or not

void core::data::sampler_t::mipmaps(bool value)

Brief

enables or disables mipmapping on this sampler.

Parameters
value in	true for enabling mipmapping.

float core::data::sampler_t::mip_bias() const

Brief

returns the mip_bias that might be present on this sampler.

Details

Returns	the mip_bias that might be present on this sampler.

void core::data::sampler_t::mip_bias(float value)

Brief

sets the mip bias when sampling mipmaps.

Details

Parameters
value in	the bias to apply to mipmap sampling.

core::gfx::sampler_mipmap_mode core::data::sampler_t::mip_mode() const

Brief

returns the mode for mipmap texture lookups.

Returns	the mode for mipmap texture lookups.

void core::data::sampler_t::mip_mode(core::gfx::sampler_mipmap_mode value)

Brief

sets the mode for mipmap texture lookups.

Parameters
value in	the mode to change to.

float core::data::sampler_t::mip_minlod() const

Brief

returns the minimal mipmap LOD this instance has set.

Returns	the minimal mipmap LOD this instance has set.

void core::data::sampler_t::mip_minlod(float value)

Brief

sets the minimal mipmap LOD offset for this instance.

Parameters
value in	the value to set.

float core::data::sampler_t::mip_maxlod() const

Brief

returns the max mipmap LOD this instance has set.

Details

Returns	the max mipmap LOD this instance has set.

void core::data::sampler_t::mip_maxlod(float value)

Brief

sets the minimal mipmap max LOD for this instance.

Parameters
value in	the value to set.

core::gfx::sampler_address_mode core::data::sampler_t::addressU() const

Brief

returns how this instances deals with texture tiling in the U-axis.

Returns	how this instances deals with texture tiling in the U-axis.

void core::data::sampler_t::addressU(core::gfx::sampler_address_mode value)

Brief

sets how this instance should deal with texture tiling in the U-axis.

Parameters
value in	the mode to set this instance to.

core::gfx::sampler_address_mode core::data::sampler_t::addressV() const

Brief

returns how this instances deals with texture tiling in the V-axis.

Returns	how this instances deals with texture tiling in the V-axis.

void core::data::sampler_t::addressV(core::gfx::sampler_address_mode value)

Brief

sets how this instance should deal with texture tiling in the V-axis.

Parameters
value in	the mode to set this instance to.

core::gfx::sampler_address_mode core::data::sampler_t::addressW() const

Brief

returns how this instances deals with texture tiling in the W-axis.

Returns	how this instances deals with texture tiling in the W-axis.

void core::data::sampler_t::addressW(core::gfx::sampler_address_mode value)

Brief

sets how this instance should deal with texture tiling in the W-axis.

Parameters
value in	the mode to set this instance to.

core::gfx::border_color core::data::sampler_t::border_color() const

Brief

returns the border color that will be used during texture lookups.

Returns	the border color that will be used during texture lookups.

void core::data::sampler_t::border_color(core::gfx::border_color value)

Brief

sets the border color that should be used during texture lookups.

Parameters
value in	the new border color value.

bool core::data::sampler_t::anisotropic_filtering() const

Brief

returns if anisotropic filtering is enabled.

Returns	if anisotropic filtering is enabled.

void core::data::sampler_t::anisotropic_filtering(bool value)

Brief

call this to enable or disable anisotropic filtering.

Details

Parameters
value in	set to true to enable anisotropic filtering.

float core::data::sampler_t::max_anisotropy() const

Brief

returns the max anistropic value for this instance.

Returns	the max anistropic value for this instance.

void core::data::sampler_t::max_anisotropy(float value)

Brief

sets the max anistropic value for this instance.

Parameters
value in	the value to set the max anisotropic value.

bool core::data::sampler_t::compare_mode() const

Brief

returns if compare operations have been enabled or not.

Returns	if compare operations have been enabled or not.

void core::data::sampler_t::compare_mode(bool value)

Brief

enables or disables compare ops.

Parameters
value in	set to true to enable compare ops.

core::gfx::compare_op core::data::sampler_t::compare_op() const

Brief

returns what compare op would be used if compare_mode() is true.

Returns	what compare op would be used if compare_mode() is true.

void core::data::sampler_t::compare_op(core::gfx::compare_op value)

Brief

sets the compare op to a new value.

Details

Parameters
value in	the new compare op to use.

core::gfx::filter core::data::sampler_t::filter_min() const

Brief

returns the filtering mode to use when dealing with minification.

Returns	the filtering mode to use when dealing with minification.

void core::data::sampler_t::filter_min(core::gfx::filter value)

Brief

sets the filtering mode to use when dealing with minification.

Parameters
value in	the new filter mode to use.

core::gfx::filter core::data::sampler_t::filter_max() const

Brief

returns the filtering mode to use when dealing with magnification.

Returns	the filtering mode to use when dealing with magnification.

void core::data::sampler_t::filter_max(core::gfx::filter value)

Brief

sets the filtering mode to use when dealing with magnification.

Parameters
value in	the new filter mode to use.

bool core::data::sampler_t::normalized_coordinates() const

Brief

returns if the coordinates for this sampler will be normalized or not.

Returns	if the coordinates for this sampler will be normalized or not.

void core::data::sampler_t::normalized_coordinates(bool value)

Brief

enables or disables coordinate normalization when this sampler is used.

Parameters
value in	enables or disables the behaviour.