Magnum::Vk::SamplerCreateInfo class new in Git master
#include <Magnum/Vk/SamplerCreateInfo.h>

Sampler creation info.

Wraps a VkSamplerCreateInfo. See Sampler creation for usage information.

Public types

enum class Flag: UnsignedInt { }
Sampler creation flag.
using Flags = Containers::EnumSet<Flag>
Sampler creation flags.

Constructors, destructors, conversion operators

SamplerCreateInfo(Flags flags = {}) explicit
Constructor.
SamplerCreateInfo(NoInitT) explicit noexcept
Construct without initializing the contents.
SamplerCreateInfo(const VkSamplerCreateInfo& info) explicit
Construct from existing data.
operator const VkSamplerCreateInfo*() const

Public functions

auto setMinificationFilter(SamplerFilter filter, SamplerMipmap mipmap) -> SamplerCreateInfo&
Set minification filter.
auto setMinificationFilter(Magnum::SamplerFilter filter, Magnum::SamplerMipmap mipmap) -> SamplerCreateInfo&
auto setMagnificationFilter(SamplerFilter filter) -> SamplerCreateInfo&
Set magnification filter.
auto setMagnificationFilter(Magnum::SamplerFilter filter) -> SamplerCreateInfo&
auto setWrapping(const Math::Vector3<SamplerWrapping>& wrapping) -> SamplerCreateInfo&
Set wrapping.
auto setWrapping(const Math::Vector3<Magnum::SamplerWrapping>& wrapping) -> SamplerCreateInfo&
auto setWrapping(SamplerWrapping wrapping) -> SamplerCreateInfo&
Set wrapping for all dimensions at once.
auto setWrapping(Magnum::SamplerWrapping wrapping) -> SamplerCreateInfo&
auto operator*() -> VkSamplerCreateInfo&
Underlying VkSamplerCreateInfo structure.
auto operator*() const -> const VkSamplerCreateInfo&
auto operator->() -> VkSamplerCreateInfo*
auto operator->() const -> const VkSamplerCreateInfo*

Enum documentation

enum class Magnum::Vk::SamplerCreateInfo::Flag: UnsignedInt

Sampler creation flag.

Wraps VkSamplerCreateFlagBits.

Typedef documentation

typedef Containers::EnumSet<Flag> Magnum::Vk::SamplerCreateInfo::Flags

Sampler creation flags.

Type-safe wrapper for VkSamplerCreateFlags.

Function documentation

Magnum::Vk::SamplerCreateInfo::SamplerCreateInfo(Flags flags = {}) explicit

Constructor.

Parameters
flags Sampler creation flags

The following VkSamplerCreateInfo fields are pre-filled in addition to sType, everything else is zero-filled:

The min/max LOD defaults are chosen to be the same as OpenGL defaults.

Magnum::Vk::SamplerCreateInfo::SamplerCreateInfo(NoInitT) explicit noexcept

Construct without initializing the contents.

Note that not even the sType field is set — the structure has to be fully initialized afterwards in order to be usable.

Magnum::Vk::SamplerCreateInfo::SamplerCreateInfo(const VkSamplerCreateInfo& info) explicit

Construct from existing data.

Copies the existing values verbatim, pointers are kept unchanged without taking over the ownership. Modifying the newly created instance will not modify the original data nor the pointed-to data.

Magnum::Vk::SamplerCreateInfo::operator const VkSamplerCreateInfo*() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

SamplerCreateInfo& Magnum::Vk::SamplerCreateInfo::setMinificationFilter(SamplerFilter filter, SamplerMipmap mipmap)

Set minification filter.

Returns Reference to self (for method chaining)

Sets the following VkSamplerCreateInfo fields:

  • minFilter to filter
  • mipmapMode to mipmap

SamplerCreateInfo& Magnum::Vk::SamplerCreateInfo::setMinificationFilter(Magnum::SamplerFilter filter, Magnum::SamplerMipmap mipmap)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

SamplerCreateInfo& Magnum::Vk::SamplerCreateInfo::setMagnificationFilter(SamplerFilter filter)

Set magnification filter.

Returns Reference to self (for method chaining)

Sets the following VkSamplerCreateInfo fields:

  • magFilter to filter

SamplerCreateInfo& Magnum::Vk::SamplerCreateInfo::setMagnificationFilter(Magnum::SamplerFilter filter)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

SamplerCreateInfo& Magnum::Vk::SamplerCreateInfo::setWrapping(const Math::Vector3<SamplerWrapping>& wrapping)

Set wrapping.

Returns Reference to self (for method chaining)

Sets the following VkSamplerCreateInfo fields:

  • addressModeU, addressModeV and addressModeW to the respective components of wrapping

SamplerCreateInfo& Magnum::Vk::SamplerCreateInfo::setWrapping(const Math::Vector3<Magnum::SamplerWrapping>& wrapping)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

SamplerCreateInfo& Magnum::Vk::SamplerCreateInfo::setWrapping(SamplerWrapping wrapping)

Set wrapping for all dimensions at once.

Returns Reference to self (for method chaining)

Same as calling setWrapping(const Math::Vector3<SamplerWrapping>&) with wrapping set for all components.

SamplerCreateInfo& Magnum::Vk::SamplerCreateInfo::setWrapping(Magnum::SamplerWrapping wrapping)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const VkSamplerCreateInfo& Magnum::Vk::SamplerCreateInfo::operator*() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

VkSamplerCreateInfo* Magnum::Vk::SamplerCreateInfo::operator->()

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const VkSamplerCreateInfo* Magnum::Vk::SamplerCreateInfo::operator->() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.