Vulkan.Core10.Sampler

Documentation

createSampler

Arguments

:: forall a io. (Extendss SamplerCreateInfo a, PokeChain a, MonadIO io)

=> Device

device is the logical device that creates the sampler.

-> SamplerCreateInfo a

pCreateInfo is a pointer to a SamplerCreateInfo structure specifying the state of the sampler object.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io Sampler

vkCreateSampler - Create a new sampler object

Valid Usage

• There must be less than PhysicalDeviceLimits::maxSamplerAllocationCount VkSampler objects currently created on the device.

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid SamplerCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pSampler must be a valid pointer to a Sampler handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

AllocationCallbacks, Device, Sampler, SamplerCreateInfo

withSampler :: forall a io r. (Extendss SamplerCreateInfo a, PokeChain a, MonadIO io) => Device -> SamplerCreateInfo a -> Maybe AllocationCallbacks -> (io Sampler -> (Sampler -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createSampler and destroySampler

To ensure that destroySampler is always called: pass bracket (or the allocate function from your favourite resource management library) as the first argument. To just extract the pair pass (,) as the first argument.

destroySampler

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that destroys the sampler.

-> Sampler

sampler is the sampler to destroy.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io ()

vkDestroySampler - Destroy a sampler object

Valid Usage

• All submitted commands that refer to sampler must have completed execution

• If AllocationCallbacks were provided when sampler was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when sampler was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If sampler is not NULL_HANDLE, sampler must be a valid Sampler handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If sampler is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to sampler must be externally synchronized

See Also

AllocationCallbacks, Device, Sampler

data SamplerCreateInfo (es :: [Type])

VkSamplerCreateInfo - Structure specifying parameters of a newly created sampler

Description

Mapping of OpenGL to Vulkan filter modes

magFilter values of FILTER_NEAREST and FILTER_LINEAR directly correspond to GL_NEAREST and GL_LINEAR magnification filters. minFilter and mipmapMode combine to correspond to the similarly named OpenGL minification filter of GL_minFilter_MIPMAP_mipmapMode (e.g. minFilter of FILTER_LINEAR and mipmapMode of SAMPLER_MIPMAP_MODE_NEAREST correspond to GL_LINEAR_MIPMAP_NEAREST).

There are no Vulkan filter modes that directly correspond to OpenGL minification filters of GL_LINEAR or GL_NEAREST, but they can be emulated using SAMPLER_MIPMAP_MODE_NEAREST, minLod = 0, and maxLod = 0.25, and using minFilter = FILTER_LINEAR or minFilter = FILTER_NEAREST, respectively.

Note that using a maxLod of zero would cause magnification to always be performed, and the magFilter to always be used. This is valid, just not an exact match for OpenGL behavior. Clamping the maximum LOD to 0.25 allows the λ value to be non-zero and minification to be performed, while still always rounding down to the base level. If the minFilter and magFilter are equal, then using a maxLod of zero also works.

The maximum number of sampler objects which can be simultaneously created on a device is implementation-dependent and specified by the maxSamplerAllocationCount member of the PhysicalDeviceLimits structure.

Note

For historical reasons, if maxSamplerAllocationCount is exceeded, some implementations may return ERROR_TOO_MANY_OBJECTS. Exceeding this limit will result in undefined behavior, and an application should not rely on the use of the returned error code in order to identify when the limit is reached.

Since Sampler is a non-dispatchable handle type, implementations may return the same handle for sampler state vectors that are identical. In such cases, all such objects would only count once against the maxSamplerAllocationCount limit.

Valid Usage

• The absolute value of mipLodBias must be less than or equal to PhysicalDeviceLimits::maxSamplerLodBias

• If the VK_KHR_portability_subset extension is enabled, and PhysicalDevicePortabilitySubsetFeaturesKHR::samplerMipLodBias is FALSE, mipLodBias must be zero.
• maxLod must be greater than or equal to minLod
• If the anisotropic sampling feature is not enabled, anisotropyEnable must be FALSE
• If anisotropyEnable is TRUE, maxAnisotropy must be between 1.0 and PhysicalDeviceLimits::maxSamplerAnisotropy, inclusive
• If sampler Y′CBCR conversion is enabled and the potential format features of the sampler Y′CBCR conversion do not support FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT, minFilter and magFilter must be equal to the sampler Y′CBCR conversion’s chromaFilter
• If unnormalizedCoordinates is TRUE, minFilter and magFilter must be equal
• If unnormalizedCoordinates is TRUE, mipmapMode must be SAMPLER_MIPMAP_MODE_NEAREST
• If unnormalizedCoordinates is TRUE, minLod and maxLod must be zero
• If unnormalizedCoordinates is TRUE, addressModeU and addressModeV must each be either SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE or SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER
• If unnormalizedCoordinates is TRUE, anisotropyEnable must be FALSE
• If unnormalizedCoordinates is TRUE, compareEnable must be FALSE
• If any of addressModeU, addressModeV or addressModeW are SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER, borderColor must be a valid BorderColor value
• If sampler Y′CBCR conversion is enabled, addressModeU, addressModeV, and addressModeW must be SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE, anisotropyEnable must be FALSE, and unnormalizedCoordinates must be FALSE
• The sampler reduction mode must be set to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE if sampler Y′CBCR conversion is enabled
• If samplerMirrorClampToEdge is not enabled, and if the VK_KHR_sampler_mirror_clamp_to_edge extension is not enabled, addressModeU, addressModeV and addressModeW must not be SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE
• If compareEnable is TRUE, compareOp must be a valid CompareOp value
• If either magFilter or minFilter is FILTER_CUBIC_EXT, anisotropyEnable must be FALSE
• If compareEnable is TRUE, the reductionMode member of SamplerReductionModeCreateInfo must be SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE
• If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then minFilter and magFilter must be equal
• If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then mipmapMode must be SAMPLER_MIPMAP_MODE_NEAREST
• If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then minLod and maxLod must be zero
• If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then addressModeU and addressModeV must each be either SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE or SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER
• If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then anisotropyEnable must be FALSE
• If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then compareEnable must be FALSE
• If flags includes SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then unnormalizedCoordinates must be FALSE
• If borderColor is one of BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT, then a SamplerCustomBorderColorCreateInfoEXT must be present in the pNext chain
• If the customBorderColors feature is not enabled, borderColor must not be BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT
• If borderColor is one of BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT, and SamplerCustomBorderColorCreateInfoEXT::format is not FORMAT_UNDEFINED, SamplerCustomBorderColorCreateInfoEXT::customBorderColor must be within the range of values representable in format.
• The maximum number of samplers with custom border colors which can be simultaneously created on a device is implementation-dependent and specified by the maxCustomBorderColorSamplers member of the PhysicalDeviceCustomBorderColorPropertiesEXT structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SAMPLER_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of SamplerCustomBorderColorCreateInfoEXT, SamplerReductionModeCreateInfo, or SamplerYcbcrConversionInfo
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of SamplerCreateFlagBits values
• magFilter must be a valid Filter value
• minFilter must be a valid Filter value
• mipmapMode must be a valid SamplerMipmapMode value
• addressModeU must be a valid SamplerAddressMode value
• addressModeV must be a valid SamplerAddressMode value
• addressModeW must be a valid SamplerAddressMode value

See Also

Bool32, BorderColor, CompareOp, Filter, SamplerAddressMode, SamplerCreateFlags, SamplerMipmapMode, StructureType, createSampler

Constructors

SamplerCreateInfo

Fields

• next :: Chain es

  pNext is NULL or a pointer to a structure extending this structure.

• flags :: SamplerCreateFlags

  flags is a bitmask of SamplerCreateFlagBits describing additional parameters of the sampler.

• magFilter :: Filter

  magFilter is a Filter value specifying the magnification filter to apply to lookups.

• minFilter :: Filter

  minFilter is a Filter value specifying the minification filter to apply to lookups.

• mipmapMode :: SamplerMipmapMode

  mipmapMode is a SamplerMipmapMode value specifying the mipmap filter to apply to lookups.

• addressModeU :: SamplerAddressMode

  addressModeU is a SamplerAddressMode value specifying the addressing mode for outside [0..1] range for U coordinate.

• addressModeV :: SamplerAddressMode

  addressModeV is a SamplerAddressMode value specifying the addressing mode for outside [0..1] range for V coordinate.

• addressModeW :: SamplerAddressMode

  addressModeW is a SamplerAddressMode value specifying the addressing mode for outside [0..1] range for W coordinate.

• mipLodBias :: Float

  mipLodBias is the bias to be added to mipmap LOD (level-of-detail) calculation and bias provided by image sampling functions in SPIR-V, as described in the Level-of-Detail Operation section.

• anisotropyEnable :: Bool

  anisotropyEnable is TRUE to enable anisotropic filtering, as described in the Texel Anisotropic Filtering section, or FALSE otherwise.

• maxAnisotropy :: Float

  maxAnisotropy is the anisotropy value clamp used by the sampler when anisotropyEnable is TRUE. If anisotropyEnable is FALSE, maxAnisotropy is ignored.

• compareEnable :: Bool

  compareEnable is TRUE to enable comparison against a reference value during lookups, or FALSE otherwise.

  • Note: Some implementations will default to shader state if this member does not match.
• compareOp :: CompareOp

  compareOp is a CompareOp value specifying the comparison function to apply to fetched data before filtering as described in the Depth Compare Operation section.

• minLod :: Float

  minLod and maxLod are the values used to clamp the computed LOD value, as described in the Level-of-Detail Operation section.

• maxLod :: Float
• borderColor :: BorderColor

  borderColor is a BorderColor value specifying the predefined border color to use.

• unnormalizedCoordinates :: Bool

  unnormalizedCoordinates controls whether to use unnormalized or normalized texel coordinates to address texels of the image. When set to TRUE, the range of the image coordinates used to lookup the texel is in the range of zero to the image dimensions for x, y and z. When set to FALSE the range of image coordinates is zero to one.

  When unnormalizedCoordinates is TRUE, images the sampler is used with in the shader have the following requirements:

  • The viewType must be either IMAGE_VIEW_TYPE_1D or IMAGE_VIEW_TYPE_2D.
  • The image view must have a single layer and a single mip level.

  When unnormalizedCoordinates is TRUE, image built-in functions in the shader that use the sampler have the following requirements:

  • The functions must not use projection.
  • The functions must not use offsets.

Instances

Extensible SamplerCreateInfo

Defined in Vulkan.Core10.Sampler

Methods

extensibleType :: StructureType

getNext :: forall (es :: [Type]). SamplerCreateInfo es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [Type]). SamplerCreateInfo ds -> Chain es -> SamplerCreateInfo es

extends :: forall e b proxy. Typeable e => proxy e -> (Extends SamplerCreateInfo e => b) -> Maybe b

Show (Chain es) => Show (SamplerCreateInfo es)

Defined in Vulkan.Core10.Sampler

Methods

showsPrec :: Int -> SamplerCreateInfo es -> ShowS

show :: SamplerCreateInfo es -> String

showList :: [SamplerCreateInfo es] -> ShowS

Generic (SamplerCreateInfo es)

Defined in Vulkan.Core10.Sampler

Associated Types

type Rep (SamplerCreateInfo es) :: Type -> Type

Methods

from :: SamplerCreateInfo es -> Rep (SamplerCreateInfo es) x

to :: Rep (SamplerCreateInfo es) x -> SamplerCreateInfo es

(Extendss SamplerCreateInfo es, PeekChain es) => FromCStruct (SamplerCreateInfo es)

Defined in Vulkan.Core10.Sampler

Methods

peekCStruct :: Ptr (SamplerCreateInfo es) -> IO (SamplerCreateInfo es)

(Extendss SamplerCreateInfo es, PokeChain es) => ToCStruct (SamplerCreateInfo es)

Defined in Vulkan.Core10.Sampler

Methods

withCStruct :: SamplerCreateInfo es -> (Ptr (SamplerCreateInfo es) -> IO b) -> IO b

pokeCStruct :: Ptr (SamplerCreateInfo es) -> SamplerCreateInfo es -> IO b -> IO b

withZeroCStruct :: (Ptr (SamplerCreateInfo es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (SamplerCreateInfo es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ('[] :: [Type]) => Zero (SamplerCreateInfo es)

Defined in Vulkan.Core10.Sampler

Methods

zero :: SamplerCreateInfo es

type Rep (SamplerCreateInfo es)

Defined in Vulkan.Core10.Sampler

type Rep (SamplerCreateInfo es) = D1 ('MetaData "SamplerCreateInfo" "Vulkan.Core10.Sampler" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "SamplerCreateInfo" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Chain es)) :*: S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SamplerCreateFlags)) :*: (S1 ('MetaSel ('Just "magFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Filter) :*: S1 ('MetaSel ('Just "minFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Filter))) :*: ((S1 ('MetaSel ('Just "mipmapMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SamplerMipmapMode) :*: S1 ('MetaSel ('Just "addressModeU") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SamplerAddressMode)) :*: (S1 ('MetaSel ('Just "addressModeV") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SamplerAddressMode) :*: S1 ('MetaSel ('Just "addressModeW") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SamplerAddressMode)))) :*: (((S1 ('MetaSel ('Just "mipLodBias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Float) :*: S1 ('MetaSel ('Just "anisotropyEnable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "maxAnisotropy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Float) :*: S1 ('MetaSel ('Just "compareEnable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "compareOp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CompareOp) :*: S1 ('MetaSel ('Just "minLod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Float)) :*: (S1 ('MetaSel ('Just "maxLod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Float) :*: (S1 ('MetaSel ('Just "borderColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BorderColor) :*: S1 ('MetaSel ('Just "unnormalizedCoordinates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))))

newtype Sampler

VkSampler - Opaque handle to a sampler object

See Also

DescriptorImageInfo, DescriptorSetLayoutBinding, ImageViewHandleInfoNVX, createSampler, destroySampler

Constructors

Sampler Word64

Instances

Eq Sampler

Defined in Vulkan.Core10.Handles

Methods

(==) :: Sampler -> Sampler -> Bool

(/=) :: Sampler -> Sampler -> Bool

Ord Sampler

Defined in Vulkan.Core10.Handles

Methods

compare :: Sampler -> Sampler -> Ordering

(<) :: Sampler -> Sampler -> Bool

(<=) :: Sampler -> Sampler -> Bool

(>) :: Sampler -> Sampler -> Bool

(>=) :: Sampler -> Sampler -> Bool

max :: Sampler -> Sampler -> Sampler

min :: Sampler -> Sampler -> Sampler

Show Sampler

Defined in Vulkan.Core10.Handles

Methods

showsPrec :: Int -> Sampler -> ShowS

show :: Sampler -> String

showList :: [Sampler] -> ShowS

Storable Sampler

Defined in Vulkan.Core10.Handles

Methods

sizeOf :: Sampler -> Int

alignment :: Sampler -> Int

peekElemOff :: Ptr Sampler -> Int -> IO Sampler

pokeElemOff :: Ptr Sampler -> Int -> Sampler -> IO ()

peekByteOff :: Ptr b -> Int -> IO Sampler

pokeByteOff :: Ptr b -> Int -> Sampler -> IO ()

peek :: Ptr Sampler -> IO Sampler

poke :: Ptr Sampler -> Sampler -> IO ()

Zero Sampler

Defined in Vulkan.Core10.Handles

Methods

zero :: Sampler

HasObjectType Sampler

Defined in Vulkan.Core10.Handles

Methods

objectTypeAndHandle :: Sampler -> (ObjectType, Word64)

IsHandle Sampler

Defined in Vulkan.Core10.Handles

newtype BorderColor

VkBorderColor - Specify border color used for texture lookups

Description

These colors are described in detail in Texel Replacement.

See Also

SamplerCreateInfo

Constructors

BorderColor Int32

Bundled Patterns

pattern BORDER_COLOR_FLOAT_TRANSPARENT_BLACK :: BorderColor

BORDER_COLOR_FLOAT_TRANSPARENT_BLACK specifies a transparent, floating-point format, black color.

pattern BORDER_COLOR_INT_TRANSPARENT_BLACK :: BorderColor

BORDER_COLOR_INT_TRANSPARENT_BLACK specifies a transparent, integer format, black color.

pattern BORDER_COLOR_FLOAT_OPAQUE_BLACK :: BorderColor

BORDER_COLOR_FLOAT_OPAQUE_BLACK specifies an opaque, floating-point format, black color.

pattern BORDER_COLOR_INT_OPAQUE_BLACK :: BorderColor

BORDER_COLOR_INT_OPAQUE_BLACK specifies an opaque, integer format, black color.

pattern BORDER_COLOR_FLOAT_OPAQUE_WHITE :: BorderColor

BORDER_COLOR_FLOAT_OPAQUE_WHITE specifies an opaque, floating-point format, white color.

pattern BORDER_COLOR_INT_OPAQUE_WHITE :: BorderColor

BORDER_COLOR_INT_OPAQUE_WHITE specifies an opaque, integer format, white color.

pattern BORDER_COLOR_INT_CUSTOM_EXT :: BorderColor

BORDER_COLOR_INT_CUSTOM_EXT indicates that a SamplerCustomBorderColorCreateInfoEXT structure is present in the SamplerCreateInfo::pNext chain which contains the color data in integer format.

pattern BORDER_COLOR_FLOAT_CUSTOM_EXT :: BorderColor

BORDER_COLOR_FLOAT_CUSTOM_EXT indicates that a SamplerCustomBorderColorCreateInfoEXT structure is present in the SamplerCreateInfo::pNext chain which contains the color data in floating-point format.

Instances

Eq BorderColor

Defined in Vulkan.Core10.Enums.BorderColor

Methods

(==) :: BorderColor -> BorderColor -> Bool

(/=) :: BorderColor -> BorderColor -> Bool

Ord BorderColor

Defined in Vulkan.Core10.Enums.BorderColor

Methods

compare :: BorderColor -> BorderColor -> Ordering

(<) :: BorderColor -> BorderColor -> Bool

(<=) :: BorderColor -> BorderColor -> Bool

(>) :: BorderColor -> BorderColor -> Bool

(>=) :: BorderColor -> BorderColor -> Bool

max :: BorderColor -> BorderColor -> BorderColor

min :: BorderColor -> BorderColor -> BorderColor

Read BorderColor

Defined in Vulkan.Core10.Enums.BorderColor

Methods

readsPrec :: Int -> ReadS BorderColor

readList :: ReadS [BorderColor]

readPrec :: ReadPrec BorderColor

readListPrec :: ReadPrec [BorderColor]

Show BorderColor

Defined in Vulkan.Core10.Enums.BorderColor

Methods

showsPrec :: Int -> BorderColor -> ShowS

show :: BorderColor -> String

showList :: [BorderColor] -> ShowS

Storable BorderColor

Defined in Vulkan.Core10.Enums.BorderColor

Methods

sizeOf :: BorderColor -> Int

alignment :: BorderColor -> Int

peekElemOff :: Ptr BorderColor -> Int -> IO BorderColor

pokeElemOff :: Ptr BorderColor -> Int -> BorderColor -> IO ()

peekByteOff :: Ptr b -> Int -> IO BorderColor

pokeByteOff :: Ptr b -> Int -> BorderColor -> IO ()

peek :: Ptr BorderColor -> IO BorderColor

poke :: Ptr BorderColor -> BorderColor -> IO ()

Zero BorderColor

Defined in Vulkan.Core10.Enums.BorderColor

Methods

zero :: BorderColor

newtype Filter

VkFilter - Specify filters used for texture lookups

Description

These filters are described in detail in Texel Filtering.

See Also

BlitImageInfo2KHR, SamplerCreateInfo, SamplerYcbcrConversionCreateInfo, cmdBlitImage

Constructors

Filter Int32

Bundled Patterns

pattern FILTER_NEAREST :: Filter

FILTER_NEAREST specifies nearest filtering.

pattern FILTER_LINEAR :: Filter

FILTER_LINEAR specifies linear filtering.

pattern FILTER_CUBIC_IMG :: Filter

Instances

Eq Filter

Defined in Vulkan.Core10.Enums.Filter

Methods

(==) :: Filter -> Filter -> Bool

(/=) :: Filter -> Filter -> Bool

Ord Filter

Defined in Vulkan.Core10.Enums.Filter

Methods

compare :: Filter -> Filter -> Ordering

(<) :: Filter -> Filter -> Bool

(<=) :: Filter -> Filter -> Bool

(>) :: Filter -> Filter -> Bool

(>=) :: Filter -> Filter -> Bool

max :: Filter -> Filter -> Filter

min :: Filter -> Filter -> Filter

Read Filter

Defined in Vulkan.Core10.Enums.Filter

Methods

readsPrec :: Int -> ReadS Filter

readList :: ReadS [Filter]

readPrec :: ReadPrec Filter

readListPrec :: ReadPrec [Filter]

Show Filter

Defined in Vulkan.Core10.Enums.Filter

Methods

showsPrec :: Int -> Filter -> ShowS

show :: Filter -> String

showList :: [Filter] -> ShowS

Storable Filter

Defined in Vulkan.Core10.Enums.Filter

Methods

sizeOf :: Filter -> Int

alignment :: Filter -> Int

peekElemOff :: Ptr Filter -> Int -> IO Filter

pokeElemOff :: Ptr Filter -> Int -> Filter -> IO ()

peekByteOff :: Ptr b -> Int -> IO Filter

pokeByteOff :: Ptr b -> Int -> Filter -> IO ()

peek :: Ptr Filter -> IO Filter

poke :: Ptr Filter -> Filter -> IO ()

Zero Filter

Defined in Vulkan.Core10.Enums.Filter

Methods

zero :: Filter

newtype SamplerMipmapMode

VkSamplerMipmapMode - Specify mipmap mode used for texture lookups

Description

These modes are described in detail in Texel Filtering.

See Also

SamplerCreateInfo

Constructors

SamplerMipmapMode Int32

Bundled Patterns

pattern SAMPLER_MIPMAP_MODE_NEAREST :: SamplerMipmapMode

SAMPLER_MIPMAP_MODE_NEAREST specifies nearest filtering.

pattern SAMPLER_MIPMAP_MODE_LINEAR :: SamplerMipmapMode

SAMPLER_MIPMAP_MODE_LINEAR specifies linear filtering.

Instances

Eq SamplerMipmapMode

Defined in Vulkan.Core10.Enums.SamplerMipmapMode

Methods

(==) :: SamplerMipmapMode -> SamplerMipmapMode -> Bool

(/=) :: SamplerMipmapMode -> SamplerMipmapMode -> Bool

Ord SamplerMipmapMode

Defined in Vulkan.Core10.Enums.SamplerMipmapMode

Methods

compare :: SamplerMipmapMode -> SamplerMipmapMode -> Ordering

(<) :: SamplerMipmapMode -> SamplerMipmapMode -> Bool

(<=) :: SamplerMipmapMode -> SamplerMipmapMode -> Bool

(>) :: SamplerMipmapMode -> SamplerMipmapMode -> Bool

(>=) :: SamplerMipmapMode -> SamplerMipmapMode -> Bool

max :: SamplerMipmapMode -> SamplerMipmapMode -> SamplerMipmapMode

min :: SamplerMipmapMode -> SamplerMipmapMode -> SamplerMipmapMode

Read SamplerMipmapMode

Defined in Vulkan.Core10.Enums.SamplerMipmapMode

Methods

readsPrec :: Int -> ReadS SamplerMipmapMode

readList :: ReadS [SamplerMipmapMode]

readPrec :: ReadPrec SamplerMipmapMode

readListPrec :: ReadPrec [SamplerMipmapMode]

Show SamplerMipmapMode

Defined in Vulkan.Core10.Enums.SamplerMipmapMode

Methods

showsPrec :: Int -> SamplerMipmapMode -> ShowS

show :: SamplerMipmapMode -> String

showList :: [SamplerMipmapMode] -> ShowS

Storable SamplerMipmapMode

Defined in Vulkan.Core10.Enums.SamplerMipmapMode

Methods

sizeOf :: SamplerMipmapMode -> Int

alignment :: SamplerMipmapMode -> Int

peekElemOff :: Ptr SamplerMipmapMode -> Int -> IO SamplerMipmapMode

pokeElemOff :: Ptr SamplerMipmapMode -> Int -> SamplerMipmapMode -> IO ()

peekByteOff :: Ptr b -> Int -> IO SamplerMipmapMode

pokeByteOff :: Ptr b -> Int -> SamplerMipmapMode -> IO ()

peek :: Ptr SamplerMipmapMode -> IO SamplerMipmapMode

poke :: Ptr SamplerMipmapMode -> SamplerMipmapMode -> IO ()

Zero SamplerMipmapMode

Defined in Vulkan.Core10.Enums.SamplerMipmapMode

Methods

zero :: SamplerMipmapMode

newtype SamplerAddressMode

VkSamplerAddressMode - Specify behavior of sampling with texture coordinates outside an image

See Also

SamplerCreateInfo

Constructors

SamplerAddressMode Int32

Bundled Patterns

pattern SAMPLER_ADDRESS_MODE_REPEAT :: SamplerAddressMode

SAMPLER_ADDRESS_MODE_REPEAT specifies that the repeat wrap mode will be used.

pattern SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT :: SamplerAddressMode

SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT specifies that the mirrored repeat wrap mode will be used.

pattern SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE :: SamplerAddressMode

SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE specifies that the clamp to edge wrap mode will be used.

pattern SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER :: SamplerAddressMode

SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER specifies that the clamp to border wrap mode will be used.

pattern SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE :: SamplerAddressMode

SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE specifies that the mirror clamp to edge wrap mode will be used. This is only valid if samplerMirrorClampToEdge is enabled, or if the VK_KHR_sampler_mirror_clamp_to_edge extension is enabled.

Instances

Eq SamplerAddressMode

Defined in Vulkan.Core10.Enums.SamplerAddressMode

Methods

(==) :: SamplerAddressMode -> SamplerAddressMode -> Bool

(/=) :: SamplerAddressMode -> SamplerAddressMode -> Bool

Ord SamplerAddressMode

Defined in Vulkan.Core10.Enums.SamplerAddressMode

Methods

compare :: SamplerAddressMode -> SamplerAddressMode -> Ordering

(<) :: SamplerAddressMode -> SamplerAddressMode -> Bool

(<=) :: SamplerAddressMode -> SamplerAddressMode -> Bool

(>) :: SamplerAddressMode -> SamplerAddressMode -> Bool

(>=) :: SamplerAddressMode -> SamplerAddressMode -> Bool

max :: SamplerAddressMode -> SamplerAddressMode -> SamplerAddressMode

min :: SamplerAddressMode -> SamplerAddressMode -> SamplerAddressMode

Read SamplerAddressMode

Defined in Vulkan.Core10.Enums.SamplerAddressMode

Methods

readsPrec :: Int -> ReadS SamplerAddressMode

readList :: ReadS [SamplerAddressMode]

readPrec :: ReadPrec SamplerAddressMode

readListPrec :: ReadPrec [SamplerAddressMode]

Show SamplerAddressMode

Defined in Vulkan.Core10.Enums.SamplerAddressMode

Methods

showsPrec :: Int -> SamplerAddressMode -> ShowS

show :: SamplerAddressMode -> String

showList :: [SamplerAddressMode] -> ShowS

Storable SamplerAddressMode

Defined in Vulkan.Core10.Enums.SamplerAddressMode

Methods

sizeOf :: SamplerAddressMode -> Int

alignment :: SamplerAddressMode -> Int

peekElemOff :: Ptr SamplerAddressMode -> Int -> IO SamplerAddressMode

pokeElemOff :: Ptr SamplerAddressMode -> Int -> SamplerAddressMode -> IO ()

peekByteOff :: Ptr b -> Int -> IO SamplerAddressMode

pokeByteOff :: Ptr b -> Int -> SamplerAddressMode -> IO ()

peek :: Ptr SamplerAddressMode -> IO SamplerAddressMode

poke :: Ptr SamplerAddressMode -> SamplerAddressMode -> IO ()

Zero SamplerAddressMode

Defined in Vulkan.Core10.Enums.SamplerAddressMode

Methods

zero :: SamplerAddressMode

newtype SamplerCreateFlagBits

VkSamplerCreateFlagBits - Bitmask specifying additional parameters of sampler

Description

Note

The approximations used when SAMPLER_CREATE_SUBSAMPLED_COARSE_RECONSTRUCTION_BIT_EXT is specified are implementation defined. Some implementations may interpolate between fragment density levels in a subsampled image. In that case, this bit may be used to decide whether the interpolation factors are calculated per fragment or at a coarser granularity.

See Also

SamplerCreateFlags

Constructors

SamplerCreateFlagBits Flags

Bundled Patterns

pattern SAMPLER_CREATE_SUBSAMPLED_COARSE_RECONSTRUCTION_BIT_EXT :: SamplerCreateFlagBits

SAMPLER_CREATE_SUBSAMPLED_COARSE_RECONSTRUCTION_BIT_EXT specifies that the implementation may use approximations when reconstructing a full color value for texture access from a subsampled image.

pattern SAMPLER_CREATE_SUBSAMPLED_BIT_EXT :: SamplerCreateFlagBits

SAMPLER_CREATE_SUBSAMPLED_BIT_EXT specifies that the sampler will read from an image created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT.

Instances

Eq SamplerCreateFlagBits

Defined in Vulkan.Core10.Enums.SamplerCreateFlagBits

Methods

(==) :: SamplerCreateFlagBits -> SamplerCreateFlagBits -> Bool

(/=) :: SamplerCreateFlagBits -> SamplerCreateFlagBits -> Bool

Ord SamplerCreateFlagBits

Defined in Vulkan.Core10.Enums.SamplerCreateFlagBits

Methods

compare :: SamplerCreateFlagBits -> SamplerCreateFlagBits -> Ordering

(<) :: SamplerCreateFlagBits -> SamplerCreateFlagBits -> Bool

(<=) :: SamplerCreateFlagBits -> SamplerCreateFlagBits -> Bool

(>) :: SamplerCreateFlagBits -> SamplerCreateFlagBits -> Bool

(>=) :: SamplerCreateFlagBits -> SamplerCreateFlagBits -> Bool

max :: SamplerCreateFlagBits -> SamplerCreateFlagBits -> SamplerCreateFlagBits

min :: SamplerCreateFlagBits -> SamplerCreateFlagBits -> SamplerCreateFlagBits

Read SamplerCreateFlagBits

Defined in Vulkan.Core10.Enums.SamplerCreateFlagBits

Methods

readsPrec :: Int -> ReadS SamplerCreateFlagBits

readList :: ReadS [SamplerCreateFlagBits]

readPrec :: ReadPrec SamplerCreateFlagBits

readListPrec :: ReadPrec [SamplerCreateFlagBits]

Show SamplerCreateFlagBits

Defined in Vulkan.Core10.Enums.SamplerCreateFlagBits

Methods

showsPrec :: Int -> SamplerCreateFlagBits -> ShowS

show :: SamplerCreateFlagBits -> String

showList :: [SamplerCreateFlagBits] -> ShowS

Storable SamplerCreateFlagBits

Defined in Vulkan.Core10.Enums.SamplerCreateFlagBits

Methods

sizeOf :: SamplerCreateFlagBits -> Int

alignment :: SamplerCreateFlagBits -> Int

peekElemOff :: Ptr SamplerCreateFlagBits -> Int -> IO SamplerCreateFlagBits

pokeElemOff :: Ptr SamplerCreateFlagBits -> Int -> SamplerCreateFlagBits -> IO ()

peekByteOff :: Ptr b -> Int -> IO SamplerCreateFlagBits

pokeByteOff :: Ptr b -> Int -> SamplerCreateFlagBits -> IO ()

peek :: Ptr SamplerCreateFlagBits -> IO SamplerCreateFlagBits

poke :: Ptr SamplerCreateFlagBits -> SamplerCreateFlagBits -> IO ()

Bits SamplerCreateFlagBits

Defined in Vulkan.Core10.Enums.SamplerCreateFlagBits

Methods

(.&.) :: SamplerCreateFlagBits -> SamplerCreateFlagBits -> SamplerCreateFlagBits

(.|.) :: SamplerCreateFlagBits -> SamplerCreateFlagBits -> SamplerCreateFlagBits

xor :: SamplerCreateFlagBits -> SamplerCreateFlagBits -> SamplerCreateFlagBits

complement :: SamplerCreateFlagBits -> SamplerCreateFlagBits

shift :: SamplerCreateFlagBits -> Int -> SamplerCreateFlagBits

rotate :: SamplerCreateFlagBits -> Int -> SamplerCreateFlagBits

zeroBits :: SamplerCreateFlagBits

bit :: Int -> SamplerCreateFlagBits

setBit :: SamplerCreateFlagBits -> Int -> SamplerCreateFlagBits

clearBit :: SamplerCreateFlagBits -> Int -> SamplerCreateFlagBits

complementBit :: SamplerCreateFlagBits -> Int -> SamplerCreateFlagBits

testBit :: SamplerCreateFlagBits -> Int -> Bool

bitSizeMaybe :: SamplerCreateFlagBits -> Maybe Int

bitSize :: SamplerCreateFlagBits -> Int

isSigned :: SamplerCreateFlagBits -> Bool

shiftL :: SamplerCreateFlagBits -> Int -> SamplerCreateFlagBits

unsafeShiftL :: SamplerCreateFlagBits -> Int -> SamplerCreateFlagBits

shiftR :: SamplerCreateFlagBits -> Int -> SamplerCreateFlagBits

unsafeShiftR :: SamplerCreateFlagBits -> Int -> SamplerCreateFlagBits

rotateL :: SamplerCreateFlagBits -> Int -> SamplerCreateFlagBits

rotateR :: SamplerCreateFlagBits -> Int -> SamplerCreateFlagBits

popCount :: SamplerCreateFlagBits -> Int

Zero SamplerCreateFlagBits

Defined in Vulkan.Core10.Enums.SamplerCreateFlagBits

Methods

zero :: SamplerCreateFlagBits

type SamplerCreateFlags = SamplerCreateFlagBits