API_Specification » APISpec_Samplers module

Chapter 12: Specification

Contents

Classes

struct VV::V1::Sampler::CreateInfo
Specification
struct VV::V1::Sampler
Represent the state of an image sampler which is used by the implementation to read image data and apply filtering and other transformations for the shader.

Enums

enum EBorderColor: ui32 { Float_TransparentBlack = VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK, Int_TransparentBlack = VK_BORDER_COLOR_INT_TRANSPARENT_BLACK, Float_OpaqueBlack = VK_BORDER_COLOR_FLOAT_OPAQUE_BLACK, Int_OpaqueBlack = VK_BORDER_COLOR_INT_OPAQUE_BLACK, Float_OpaqueWhite = VK_BORDER_COLOR_FLOAT_OPAQUE_WHITE, Int_OpaqueWhite = VK_BORDER_COLOR_INT_OPAQUE_WHITE, Float_Custom_EXT = VK_BORDER_COLOR_FLOAT_CUSTOM_EXT, Int_Custom_EXT = VK_BORDER_COLOR_INT_CUSTOM_EXT }
Specification
enum class EFilter: ui32 { Nearest = VK_FILTER_NEAREST, Linear = VK_FILTER_LINEAR, Cubic = VK_FILTER_CUBIC_IMG, Cubic_EXT = VK_FILTER_CUBIC_EXT }
Specification
enum class ESamplerMipmapMode: ui32 { Nearest = VK_SAMPLER_MIPMAP_MODE_NEAREST, Linear = VK_SAMPLER_MIPMAP_MODE_LINEAR }
Specification

Typedefs

using Handle = VkSampler
Specification
using CreateFlags = Bitfield<ESamplerCreateFlag, VkSamplerCreateFlags>
Specification

Functions

static auto Create(LogicalDevice::Handle _device, const CreateInfo& _createInfo, const Memory::AllocationCallbacks* _allocator, Handle& _sampler) -> EResult
Create a sampler object.
static void Destroy(LogicalDevice::Handle _device, Handle _sampler, const Memory::AllocationCallbacks* _allocator)
Destroy a sampler.

Enum documentation

Typedef documentation

using CreateFlags = Bitfield<ESamplerCreateFlag, VkSamplerCreateFlags>

Specification

Function documentation

static EResult Create(LogicalDevice::Handle _device, const CreateInfo& _createInfo, const Memory::AllocationCallbacks* _allocator, Handle& _sampler)

Create a sampler object.

Parameters
_device
_createInfo
_allocator
_sampler

Specification

static void Destroy(LogicalDevice::Handle _device, Handle _sampler, const Memory::AllocationCallbacks* _allocator)

Destroy a sampler.

Parameters
_device
_sampler
_allocator

Specification