Vulkan.Core10.Enums.ImageCreateFlagBits

Documentation

newtype ImageCreateFlagBits

VkImageCreateFlagBits - Bitmask specifying additional parameters of an image

Description

See Sparse Resource Features and Sparse Physical Device Features for more details.

See Also

ImageCreateFlags

Constructors

ImageCreateFlagBits Flags

Bundled Patterns

pattern IMAGE_CREATE_SPARSE_BINDING_BIT :: ImageCreateFlagBits

IMAGE_CREATE_SPARSE_BINDING_BIT specifies that the image will be backed using sparse memory binding.

pattern IMAGE_CREATE_SPARSE_RESIDENCY_BIT :: ImageCreateFlagBits

IMAGE_CREATE_SPARSE_RESIDENCY_BIT specifies that the image can be partially backed using sparse memory binding. Images created with this flag must also be created with the IMAGE_CREATE_SPARSE_BINDING_BIT flag.

pattern IMAGE_CREATE_SPARSE_ALIASED_BIT :: ImageCreateFlagBits

IMAGE_CREATE_SPARSE_ALIASED_BIT specifies that the image will be backed using sparse memory binding with memory ranges that might also simultaneously be backing another image (or another portion of the same image). Images created with this flag must also be created with the IMAGE_CREATE_SPARSE_BINDING_BIT flag

pattern IMAGE_CREATE_MUTABLE_FORMAT_BIT :: ImageCreateFlagBits

IMAGE_CREATE_MUTABLE_FORMAT_BIT specifies that the image can be used to create a ImageView with a different format from the image. For multi-planar formats, IMAGE_CREATE_MUTABLE_FORMAT_BIT specifies that a ImageView can be created of a plane of the image.

pattern IMAGE_CREATE_CUBE_COMPATIBLE_BIT :: ImageCreateFlagBits

IMAGE_CREATE_CUBE_COMPATIBLE_BIT specifies that the image can be used to create a ImageView of type IMAGE_VIEW_TYPE_CUBE or IMAGE_VIEW_TYPE_CUBE_ARRAY.

pattern IMAGE_CREATE_SUBSAMPLED_BIT_EXT :: ImageCreateFlagBits

IMAGE_CREATE_SUBSAMPLED_BIT_EXT specifies that an image can be in a subsampled format which may be more optimal when written as an attachment by a render pass that has a fragment density map attachment. Accessing a subsampled image has additional considerations:

• Image data read as an image sampler will have undefined values if the sampler was not created with flags containing SAMPLER_CREATE_SUBSAMPLED_BIT_EXT or was not sampled through the use of a combined image sampler with an immutable sampler in DescriptorSetLayoutBinding.
• Image data read with an input attachment will have undefined values if the contents were not written as an attachment in an earlier subpass of the same render pass.
• Image data read as an image sampler in the fragment shader will be additionally be read by the device during PIPELINE_STAGE_VERTEX_SHADER_BIT if ::subsampledCoarseReconstructionEarlyAccess is TRUE and the sampler was created with flags containing SAMPLER_CREATE_SUBSAMPLED_COARSE_RECONSTRUCTION_BIT_EXT.
• Image data read with load operations are resampled to the fragment density of the render pass if ::subsampledLoads is TRUE. Otherwise, values of image data are undefined.
• Image contents outside of the render area take on undefined values if the image is stored as a render pass attachment.

pattern IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT :: ImageCreateFlagBits

IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT specifies that an image with a depth or depth/stencil format can be used with custom sample locations when used as a depth/stencil attachment.

pattern IMAGE_CREATE_CORNER_SAMPLED_BIT_NV :: ImageCreateFlagBits

IMAGE_CREATE_CORNER_SAMPLED_BIT_NV specifies that the image is a corner-sampled image.

pattern IMAGE_CREATE_DISJOINT_BIT :: ImageCreateFlagBits

IMAGE_CREATE_DISJOINT_BIT specifies that an image with a multi-planar format must have each plane separately bound to memory, rather than having a single memory binding for the whole image; the presence of this bit distinguishes a disjoint image from an image without this bit set.

pattern IMAGE_CREATE_PROTECTED_BIT :: ImageCreateFlagBits

IMAGE_CREATE_PROTECTED_BIT specifies that the image is a protected image.

pattern IMAGE_CREATE_EXTENDED_USAGE_BIT :: ImageCreateFlagBits

IMAGE_CREATE_EXTENDED_USAGE_BIT specifies that the image can be created with usage flags that are not supported for the format the image is created with but are supported for at least one format a ImageView created from the image can have.

pattern IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT :: ImageCreateFlagBits

IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT specifies that the image having a compressed format can be used to create a ImageView with an uncompressed format where each texel in the image view corresponds to a compressed texel block of the image.

pattern IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT :: ImageCreateFlagBits

IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT specifies that the image can be used to create a ImageView of type IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY.

pattern IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT :: ImageCreateFlagBits

IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT specifies that the image can be used with a non-zero value of the splitInstanceBindRegionCount member of a BindImageMemoryDeviceGroupInfo structure passed into bindImageMemory2. This flag also has the effect of making the image use the standard sparse image block dimensions.

pattern IMAGE_CREATE_ALIAS_BIT :: ImageCreateFlagBits

IMAGE_CREATE_ALIAS_BIT specifies that two images created with the same creation parameters and aliased to the same memory can interpret the contents of the memory consistently with each other, subject to the rules described in the Memory Aliasing section. This flag further specifies that each plane of a disjoint image can share an in-memory non-linear representation with single-plane images, and that a single-plane image can share an in-memory non-linear representation with a plane of a multi-planar disjoint image, according to the rules in https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-compatible-planes. If the pNext chain includes a ExternalMemoryImageCreateInfo or ExternalMemoryImageCreateInfoNV structure whose handleTypes member is not 0, it is as if IMAGE_CREATE_ALIAS_BIT is set.

Instances

Eq ImageCreateFlagBits

Defined in Vulkan.Core10.Enums.ImageCreateFlagBits

Methods

(==) :: ImageCreateFlagBits -> ImageCreateFlagBits -> Bool

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

Ord ImageCreateFlagBits

Defined in Vulkan.Core10.Enums.ImageCreateFlagBits

Methods

compare :: ImageCreateFlagBits -> ImageCreateFlagBits -> Ordering

(<) :: ImageCreateFlagBits -> ImageCreateFlagBits -> Bool

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

(>) :: ImageCreateFlagBits -> ImageCreateFlagBits -> Bool

(>=) :: ImageCreateFlagBits -> ImageCreateFlagBits -> Bool

max :: ImageCreateFlagBits -> ImageCreateFlagBits -> ImageCreateFlagBits

min :: ImageCreateFlagBits -> ImageCreateFlagBits -> ImageCreateFlagBits

Read ImageCreateFlagBits

Defined in Vulkan.Core10.Enums.ImageCreateFlagBits

Methods

readsPrec :: Int -> ReadS ImageCreateFlagBits

readList :: ReadS [ImageCreateFlagBits]

readPrec :: ReadPrec ImageCreateFlagBits

readListPrec :: ReadPrec [ImageCreateFlagBits]

Show ImageCreateFlagBits

Defined in Vulkan.Core10.Enums.ImageCreateFlagBits

Methods

showsPrec :: Int -> ImageCreateFlagBits -> ShowS

show :: ImageCreateFlagBits -> String

showList :: [ImageCreateFlagBits] -> ShowS

Storable ImageCreateFlagBits

Defined in Vulkan.Core10.Enums.ImageCreateFlagBits

Methods

sizeOf :: ImageCreateFlagBits -> Int

alignment :: ImageCreateFlagBits -> Int

peekElemOff :: Ptr ImageCreateFlagBits -> Int -> IO ImageCreateFlagBits

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

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

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

peek :: Ptr ImageCreateFlagBits -> IO ImageCreateFlagBits

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

Bits ImageCreateFlagBits

Defined in Vulkan.Core10.Enums.ImageCreateFlagBits

Methods

(.&.) :: ImageCreateFlagBits -> ImageCreateFlagBits -> ImageCreateFlagBits

(.|.) :: ImageCreateFlagBits -> ImageCreateFlagBits -> ImageCreateFlagBits

xor :: ImageCreateFlagBits -> ImageCreateFlagBits -> ImageCreateFlagBits

complement :: ImageCreateFlagBits -> ImageCreateFlagBits

shift :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits

rotate :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits

zeroBits :: ImageCreateFlagBits

bit :: Int -> ImageCreateFlagBits

setBit :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits

clearBit :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits

complementBit :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits

testBit :: ImageCreateFlagBits -> Int -> Bool

bitSizeMaybe :: ImageCreateFlagBits -> Maybe Int

bitSize :: ImageCreateFlagBits -> Int

isSigned :: ImageCreateFlagBits -> Bool

shiftL :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits

unsafeShiftL :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits

shiftR :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits

unsafeShiftR :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits

rotateL :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits

rotateR :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits

popCount :: ImageCreateFlagBits -> Int

Zero ImageCreateFlagBits

Defined in Vulkan.Core10.Enums.ImageCreateFlagBits

Methods

zero :: ImageCreateFlagBits

type ImageCreateFlags = ImageCreateFlagBits