Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_EXT_image_compression_control

Description

Name

VK_EXT_image_compression_control - device extension

VK_EXT_image_compression_control

Name String: VK_EXT_image_compression_control

Extension Type

Device extension

Registered Extension Number

339

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2

Contact

Jan-Harald Fredriksen @janharaldfredriksen-arm%0A*Here describe the issue or question you have about the VK_EXT_image_compression_control extension*

Extension Proposal

VK_EXT_image_compression_control

Other Extension Metadata

Last Modified Date: 2022-05-02

IP Status

No known IP claims.

Contributors

Jan-Harald Fredriksen, Arm
Graeme Leese, Broadcom
Andrew Garrard, Imagination
Lisa Wu, Arm
Peter Kohaut, Arm

Description

This extension enables fixed-rate image compression and adds the ability to control when this kind of compression can be applied. Many implementations support some form of framebuffer compression. This is typically transparent to applications as lossless compression schemes are used. With fixed-rate compression, the compression is done at a defined bitrate. Such compression algorithms generally produce results that are visually lossless, but the results are typically not bit-exact when compared to a non-compressed result. The implementation may not be able to use the requested compression rate in all cases. This extension adds a query that can be used to determine the compression scheme and rate that was applied to an image.

New Commands

getImageSubresourceLayout2EXT

New Structures

ImageSubresource2EXT

SubresourceLayout2EXT
Extending ImageCreateInfo, SwapchainCreateInfoKHR, PhysicalDeviceImageFormatInfo2:
- ImageCompressionControlEXT
Extending ImageFormatProperties2, SurfaceFormat2KHR, SubresourceLayout2KHR:
- ImageCompressionPropertiesEXT
Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceImageCompressionControlFeaturesEXT

New Enums

ImageCompressionFixedRateFlagBitsEXT

ImageCompressionFlagBitsEXT

New Bitmasks

ImageCompressionFixedRateFlagsEXT

ImageCompressionFlagsEXT

New Enum Constants

EXT_IMAGE_COMPRESSION_CONTROL_EXTENSION_NAME

Version History

Revision 1, 2022-05-02 (Jan-Harald Fredriksen)
- Initial draft

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

pattern STRUCTURE_TYPE_SUBRESOURCE_LAYOUT_2_EXT :: StructureType
pattern STRUCTURE_TYPE_IMAGE_SUBRESOURCE_2_EXT :: StructureType
data ImageCompressionControlEXT = ImageCompressionControlEXT {
}
data PhysicalDeviceImageCompressionControlFeaturesEXT = PhysicalDeviceImageCompressionControlFeaturesEXT {
- imageCompressionControl :: Bool
}
data ImageCompressionPropertiesEXT = ImageCompressionPropertiesEXT {
- imageCompressionFlags :: ImageCompressionFlagsEXT
- imageCompressionFixedRateFlags :: ImageCompressionFixedRateFlagsEXT
}
type ImageCompressionFlagsEXT = ImageCompressionFlagBitsEXT
newtype ImageCompressionFlagBitsEXT where
- ImageCompressionFlagBitsEXT Flags
- pattern IMAGE_COMPRESSION_DEFAULT_EXT :: ImageCompressionFlagBitsEXT
- pattern IMAGE_COMPRESSION_FIXED_RATE_DEFAULT_EXT :: ImageCompressionFlagBitsEXT
- pattern IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT :: ImageCompressionFlagBitsEXT
- pattern IMAGE_COMPRESSION_DISABLED_EXT :: ImageCompressionFlagBitsEXT
type ImageCompressionFixedRateFlagsEXT = ImageCompressionFixedRateFlagBitsEXT
newtype ImageCompressionFixedRateFlagBitsEXT where
type EXT_IMAGE_COMPRESSION_CONTROL_SPEC_VERSION = 1
pattern EXT_IMAGE_COMPRESSION_CONTROL_SPEC_VERSION :: forall a. Integral a => a
type EXT_IMAGE_COMPRESSION_CONTROL_EXTENSION_NAME = "VK_EXT_image_compression_control"
pattern EXT_IMAGE_COMPRESSION_CONTROL_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
data ImageSubresource2KHR = ImageSubresource2KHR {
- imageSubresource :: ImageSubresource
}
data SubresourceLayout2KHR (es :: [Type]) = SubresourceLayout2KHR {
- next :: Chain es
- subresourceLayout :: SubresourceLayout
}
getImageSubresourceLayout2KHR :: forall a io. (Extendss SubresourceLayout2KHR a, PokeChain a, PeekChain a, MonadIO io) => Device -> Image -> ImageSubresource2KHR -> io (SubresourceLayout2KHR a)
type ImageSubresource2EXT = ImageSubresource2KHR
type SubresourceLayout2EXT = SubresourceLayout2KHR
getImageSubresourceLayout2EXT :: forall {a :: [Type]} {io}. (Extendss SubresourceLayout2KHR a, PokeChain a, PeekChain a, MonadIO io) => Device -> Image -> ImageSubresource2KHR -> io (SubresourceLayout2KHR a)

Documentation

pattern STRUCTURE_TYPE_SUBRESOURCE_LAYOUT_2_EXT :: StructureType Source #

pattern STRUCTURE_TYPE_IMAGE_SUBRESOURCE_2_EXT :: StructureType Source #

data ImageCompressionControlEXT Source #

VkImageCompressionControlEXT - Specify image compression properties

Description

If enabled, fixed-rate compression is done in an implementation-defined manner and may be applied at block granularity. In that case, a write to an individual texel may modify the value of other texels in the same block.

Valid Usage

flags must be one of IMAGE_COMPRESSION_DEFAULT_EXT, IMAGE_COMPRESSION_FIXED_RATE_DEFAULT_EXT, IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT, or IMAGE_COMPRESSION_DISABLED_EXT

If flags includes IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT, pFixedRateFlags must not be NULL

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_IMAGE_COMPRESSION_CONTROL_EXT

Note

Some combinations of compression properties may not be supported. For example, some implementations may not support different fixed-rate compression rates per plane of a multi-planar format and will not be able to enable fixed-rate compression for any plane if the requested rates differ.

Members

This structure describes the following feature:

Description

If the PhysicalDeviceImageCompressionControlFeaturesEXT structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceImageCompressionControlFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

Description

If ImageCompressionControlEXT::flags is IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT, then the ith member of the pFixedRateFlags array specifies the allowed compression rates for the image’s ith plane.

Note

If IMAGE_COMPRESSION_DISABLED_EXT is included in ImageCompressionControlEXT::flags, both lossless and fixed-rate compression will be disabled. This is likely to have a negative impact on performance and is only intended to be used for debugging purposes.

Description

If the format has a different bit rate for different components, ImageCompressionControlEXT::pFixedRateFlags describes the rate of the component with the largest number of bits assigned to it, scaled pro rata. For example, to request that a FORMAT_A2R10G10B10_UNORM_PACK32 format be stored at a rate of 8 bits per pixel, use IMAGE_COMPRESSION_FIXED_RATE_2BPC_BIT_EXT (10 bits for the largest component, stored at quarter the original size, 2.5 bits, rounded down).

If flags includes IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT, and multiple bits are set in ImageCompressionControlEXT::pFixedRateFlags for a plane, implementations should apply the lowest allowed bitrate that is supported.

Note

The choice of “bits per component” terminology was chosen so that the same compression rate describes the same degree of compression applied to formats that differ only in the number of components. For example, FORMAT_R8G8_UNORM compressed to half its original size is a rate of 4 bits per component, 8 bits per pixel. FORMAT_R8G8B8A8_UNORM compressed to half its original size is 4 bits per component, 16 bits per pixel. Both of these cases can be requested with IMAGE_COMPRESSION_FIXED_RATE_4BPC_BIT_EXT.

pattern IMAGE_COMPRESSION_FIXED_RATE_NONE_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_NONE_EXT` specifies that fixed-rate compression must not be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_1BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_1BPC_BIT_EXT` specifies that fixed-rate compression with a bitrate of [1,2) bits per component may be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_2BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_2BPC_BIT_EXT` specifies that fixed-rate compression with a bitrate of [2,3) bits per component may be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_3BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_3BPC_BIT_EXT` specifies that fixed-rate compression with a bitrate of [3,4) bits per component may be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_4BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_4BPC_BIT_EXT` specifies that fixed-rate compression with a bitrate of [4,5) bits per component may be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_5BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_5BPC_BIT_EXT` specifies that fixed-rate compression with a bitrate of [5,6) bits per component may be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_6BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_6BPC_BIT_EXT` specifies that fixed-rate compression with a bitrate of [6,7) bits per component may be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_7BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_7BPC_BIT_EXT` specifies that fixed-rate compression with a bitrate of [7,8) bits per component may be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_8BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_8BPC_BIT_EXT` specifies that fixed-rate compression with a bitrate of [8,9) bits per component may be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_9BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_9BPC_BIT_EXT` specifies that fixed-rate compression with a bitrate of [9,10) bits per component may be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_10BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_10BPC_BIT_EXT` specifies that fixed-rate compression with a bitrate of [10,11) bits per component may be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_11BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_11BPC_BIT_EXT` specifies that fixed-rate compression with a bitrate of [11,12) bits per component may be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_12BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_12BPC_BIT_EXT` specifies that fixed-rate compression with a bitrate of at least 12 bits per component may be used.
pattern IMAGE_COMPRESSION_FIXED_RATE_13BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT
pattern IMAGE_COMPRESSION_FIXED_RATE_14BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT
pattern IMAGE_COMPRESSION_FIXED_RATE_15BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT
pattern IMAGE_COMPRESSION_FIXED_RATE_16BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT
pattern IMAGE_COMPRESSION_FIXED_RATE_17BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT
pattern IMAGE_COMPRESSION_FIXED_RATE_18BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT
pattern IMAGE_COMPRESSION_FIXED_RATE_19BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT
pattern IMAGE_COMPRESSION_FIXED_RATE_20BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT
pattern IMAGE_COMPRESSION_FIXED_RATE_21BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT
pattern IMAGE_COMPRESSION_FIXED_RATE_22BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT
pattern IMAGE_COMPRESSION_FIXED_RATE_23BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT
pattern IMAGE_COMPRESSION_FIXED_RATE_24BPC_BIT_EXT :: ImageCompressionFixedRateFlagBitsEXT

Instances

Instances details

Storable ImageCompressionFixedRateFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods sizeOf :: ImageCompressionFixedRateFlagBitsEXT -> Int # alignment :: ImageCompressionFixedRateFlagBitsEXT -> Int # peekElemOff :: Ptr ImageCompressionFixedRateFlagBitsEXT -> Int -> IO ImageCompressionFixedRateFlagBitsEXT # pokeElemOff :: Ptr ImageCompressionFixedRateFlagBitsEXT -> Int -> ImageCompressionFixedRateFlagBitsEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO ImageCompressionFixedRateFlagBitsEXT # pokeByteOff :: Ptr b -> Int -> ImageCompressionFixedRateFlagBitsEXT -> IO () # peek :: Ptr ImageCompressionFixedRateFlagBitsEXT -> IO ImageCompressionFixedRateFlagBitsEXT # poke :: Ptr ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> IO () #
Bits ImageCompressionFixedRateFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods (.&.) :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT # (.\|.) :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT # xor :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT # complement :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT # shift :: ImageCompressionFixedRateFlagBitsEXT -> Int -> ImageCompressionFixedRateFlagBitsEXT # rotate :: ImageCompressionFixedRateFlagBitsEXT -> Int -> ImageCompressionFixedRateFlagBitsEXT # zeroBits :: ImageCompressionFixedRateFlagBitsEXT # bit :: Int -> ImageCompressionFixedRateFlagBitsEXT # setBit :: ImageCompressionFixedRateFlagBitsEXT -> Int -> ImageCompressionFixedRateFlagBitsEXT # clearBit :: ImageCompressionFixedRateFlagBitsEXT -> Int -> ImageCompressionFixedRateFlagBitsEXT # complementBit :: ImageCompressionFixedRateFlagBitsEXT -> Int -> ImageCompressionFixedRateFlagBitsEXT # testBit :: ImageCompressionFixedRateFlagBitsEXT -> Int -> Bool # bitSizeMaybe :: ImageCompressionFixedRateFlagBitsEXT -> Maybe Int # bitSize :: ImageCompressionFixedRateFlagBitsEXT -> Int # isSigned :: ImageCompressionFixedRateFlagBitsEXT -> Bool # shiftL :: ImageCompressionFixedRateFlagBitsEXT -> Int -> ImageCompressionFixedRateFlagBitsEXT # unsafeShiftL :: ImageCompressionFixedRateFlagBitsEXT -> Int -> ImageCompressionFixedRateFlagBitsEXT # shiftR :: ImageCompressionFixedRateFlagBitsEXT -> Int -> ImageCompressionFixedRateFlagBitsEXT # unsafeShiftR :: ImageCompressionFixedRateFlagBitsEXT -> Int -> ImageCompressionFixedRateFlagBitsEXT # rotateL :: ImageCompressionFixedRateFlagBitsEXT -> Int -> ImageCompressionFixedRateFlagBitsEXT # rotateR :: ImageCompressionFixedRateFlagBitsEXT -> Int -> ImageCompressionFixedRateFlagBitsEXT # popCount :: ImageCompressionFixedRateFlagBitsEXT -> Int #
FiniteBits ImageCompressionFixedRateFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods finiteBitSize :: ImageCompressionFixedRateFlagBitsEXT -> Int # countLeadingZeros :: ImageCompressionFixedRateFlagBitsEXT -> Int # countTrailingZeros :: ImageCompressionFixedRateFlagBitsEXT -> Int #
Read ImageCompressionFixedRateFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods readsPrec :: Int -> ReadS ImageCompressionFixedRateFlagBitsEXT # readList :: ReadS [ImageCompressionFixedRateFlagBitsEXT] # readPrec :: ReadPrec ImageCompressionFixedRateFlagBitsEXT # readListPrec :: ReadPrec [ImageCompressionFixedRateFlagBitsEXT] #
Show ImageCompressionFixedRateFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods showsPrec :: Int -> ImageCompressionFixedRateFlagBitsEXT -> ShowS # show :: ImageCompressionFixedRateFlagBitsEXT -> String # showList :: [ImageCompressionFixedRateFlagBitsEXT] -> ShowS #
Eq ImageCompressionFixedRateFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods (==) :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> Bool # (/=) :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> Bool #
Ord ImageCompressionFixedRateFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods compare :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> Ordering # (<) :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> Bool # (<=) :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> Bool # (>) :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> Bool # (>=) :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> Bool # max :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT # min :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT #
Zero ImageCompressionFixedRateFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods zero :: ImageCompressionFixedRateFlagBitsEXT Source #

type EXT_IMAGE_COMPRESSION_CONTROL_SPEC_VERSION = 1 Source #

pattern EXT_IMAGE_COMPRESSION_CONTROL_SPEC_VERSION :: forall a. Integral a => a Source #

type EXT_IMAGE_COMPRESSION_CONTROL_EXTENSION_NAME = "VK_EXT_image_compression_control" Source #

pattern EXT_IMAGE_COMPRESSION_CONTROL_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #

data ImageSubresource2KHR Source #

VkImageSubresource2KHR - Structure specifying an image subresource

Valid Usage (Implicit)

Description

getImageSubresourceLayout2KHR behaves similarly to getImageSubresourceLayout, with the ability to specify extended inputs via chained input structures, and to return extended information via chained output structures.

It is legal to call getImageSubresourceLayout2KHR with a image created with tiling equal to IMAGE_TILING_OPTIMAL, but the members of SubresourceLayout2KHR::subresourceLayout will have undefined values in this case.

Note

Structures chained from ImageSubresource2KHR::pNext will also be updated when tiling is equal to IMAGE_TILING_OPTIMAL.

Valid Usage

The aspectMask member of pSubresource must only have a single bit set

The mipLevel member of pSubresource must be less than the mipLevels specified in ImageCreateInfo when image was created
The arrayLayer member of pSubresource must be less than the arrayLayers specified in ImageCreateInfo when image was created
If format of the image is a color format, tiling of the image is IMAGE_TILING_LINEAR or IMAGE_TILING_OPTIMAL, and does not have a multi-planar image format, the aspectMask member of pSubresource must be IMAGE_ASPECT_COLOR_BIT
If format of the image has a depth component, the aspectMask member of pSubresource must contain IMAGE_ASPECT_DEPTH_BIT
If format of the image has a stencil component, the aspectMask member of pSubresource must contain IMAGE_ASPECT_STENCIL_BIT
If format of the image does not contain a stencil or depth component, the aspectMask member of pSubresource must not contain IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
If the tiling of the image is IMAGE_TILING_LINEAR and has a multi-planar image format, then the aspectMask member of pSubresource must be a single valid multi-planar aspect mask bit
If image was created with the EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID external memory handle type, then image must be bound to memory
If the tiling of the image is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then the aspectMask member of pSubresource must be VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT and the index i must be less than the DrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount associated with the image’s format and ImageDrmFormatModifierPropertiesEXT::drmFormatModifier

Valid Usage (Implicit)

device must be a valid Device handle

image must be a valid Image handle
pSubresource must be a valid pointer to a valid ImageSubresource2KHR structure
pLayout must be a valid pointer to a SubresourceLayout2KHR structure
image must have been created, allocated, or retrieved from device

Storable ImageCompressionControlEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods sizeOf :: ImageCompressionControlEXT -> Int # alignment :: ImageCompressionControlEXT -> Int # peekElemOff :: Ptr ImageCompressionControlEXT -> Int -> IO ImageCompressionControlEXT # pokeElemOff :: Ptr ImageCompressionControlEXT -> Int -> ImageCompressionControlEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO ImageCompressionControlEXT # pokeByteOff :: Ptr b -> Int -> ImageCompressionControlEXT -> IO () # peek :: Ptr ImageCompressionControlEXT -> IO ImageCompressionControlEXT # poke :: Ptr ImageCompressionControlEXT -> ImageCompressionControlEXT -> IO () #
Show ImageCompressionControlEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods showsPrec :: Int -> ImageCompressionControlEXT -> ShowS # show :: ImageCompressionControlEXT -> String # showList :: [ImageCompressionControlEXT] -> ShowS #
Eq ImageCompressionControlEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods (==) :: ImageCompressionControlEXT -> ImageCompressionControlEXT -> Bool # (/=) :: ImageCompressionControlEXT -> ImageCompressionControlEXT -> Bool #
FromCStruct ImageCompressionControlEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods peekCStruct :: Ptr ImageCompressionControlEXT -> IO ImageCompressionControlEXT Source #
ToCStruct ImageCompressionControlEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods withCStruct :: ImageCompressionControlEXT -> (Ptr ImageCompressionControlEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr ImageCompressionControlEXT -> ImageCompressionControlEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr ImageCompressionControlEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ImageCompressionControlEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ImageCompressionControlEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods zero :: ImageCompressionControlEXT Source #

Storable PhysicalDeviceImageCompressionControlFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods sizeOf :: PhysicalDeviceImageCompressionControlFeaturesEXT -> Int # alignment :: PhysicalDeviceImageCompressionControlFeaturesEXT -> Int # peekElemOff :: Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> Int -> IO PhysicalDeviceImageCompressionControlFeaturesEXT # pokeElemOff :: Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> Int -> PhysicalDeviceImageCompressionControlFeaturesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceImageCompressionControlFeaturesEXT # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceImageCompressionControlFeaturesEXT -> IO () # peek :: Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> IO PhysicalDeviceImageCompressionControlFeaturesEXT # poke :: Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> PhysicalDeviceImageCompressionControlFeaturesEXT -> IO () #
Show PhysicalDeviceImageCompressionControlFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods showsPrec :: Int -> PhysicalDeviceImageCompressionControlFeaturesEXT -> ShowS # show :: PhysicalDeviceImageCompressionControlFeaturesEXT -> String # showList :: [PhysicalDeviceImageCompressionControlFeaturesEXT] -> ShowS #
Eq PhysicalDeviceImageCompressionControlFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods (==) :: PhysicalDeviceImageCompressionControlFeaturesEXT -> PhysicalDeviceImageCompressionControlFeaturesEXT -> Bool # (/=) :: PhysicalDeviceImageCompressionControlFeaturesEXT -> PhysicalDeviceImageCompressionControlFeaturesEXT -> Bool #
FromCStruct PhysicalDeviceImageCompressionControlFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods peekCStruct :: Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> IO PhysicalDeviceImageCompressionControlFeaturesEXT Source #
ToCStruct PhysicalDeviceImageCompressionControlFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods withCStruct :: PhysicalDeviceImageCompressionControlFeaturesEXT -> (Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> PhysicalDeviceImageCompressionControlFeaturesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceImageCompressionControlFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods zero :: PhysicalDeviceImageCompressionControlFeaturesEXT Source #

Storable ImageCompressionPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods sizeOf :: ImageCompressionPropertiesEXT -> Int # alignment :: ImageCompressionPropertiesEXT -> Int # peekElemOff :: Ptr ImageCompressionPropertiesEXT -> Int -> IO ImageCompressionPropertiesEXT # pokeElemOff :: Ptr ImageCompressionPropertiesEXT -> Int -> ImageCompressionPropertiesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO ImageCompressionPropertiesEXT # pokeByteOff :: Ptr b -> Int -> ImageCompressionPropertiesEXT -> IO () # peek :: Ptr ImageCompressionPropertiesEXT -> IO ImageCompressionPropertiesEXT # poke :: Ptr ImageCompressionPropertiesEXT -> ImageCompressionPropertiesEXT -> IO () #
Show ImageCompressionPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods showsPrec :: Int -> ImageCompressionPropertiesEXT -> ShowS # show :: ImageCompressionPropertiesEXT -> String # showList :: [ImageCompressionPropertiesEXT] -> ShowS #
Eq ImageCompressionPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods (==) :: ImageCompressionPropertiesEXT -> ImageCompressionPropertiesEXT -> Bool # (/=) :: ImageCompressionPropertiesEXT -> ImageCompressionPropertiesEXT -> Bool #
FromCStruct ImageCompressionPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods peekCStruct :: Ptr ImageCompressionPropertiesEXT -> IO ImageCompressionPropertiesEXT Source #
ToCStruct ImageCompressionPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods withCStruct :: ImageCompressionPropertiesEXT -> (Ptr ImageCompressionPropertiesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr ImageCompressionPropertiesEXT -> ImageCompressionPropertiesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr ImageCompressionPropertiesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ImageCompressionPropertiesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ImageCompressionPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods zero :: ImageCompressionPropertiesEXT Source #

Storable ImageCompressionFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods sizeOf :: ImageCompressionFlagBitsEXT -> Int # alignment :: ImageCompressionFlagBitsEXT -> Int # peekElemOff :: Ptr ImageCompressionFlagBitsEXT -> Int -> IO ImageCompressionFlagBitsEXT # pokeElemOff :: Ptr ImageCompressionFlagBitsEXT -> Int -> ImageCompressionFlagBitsEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO ImageCompressionFlagBitsEXT # pokeByteOff :: Ptr b -> Int -> ImageCompressionFlagBitsEXT -> IO () # peek :: Ptr ImageCompressionFlagBitsEXT -> IO ImageCompressionFlagBitsEXT # poke :: Ptr ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> IO () #
Bits ImageCompressionFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods (.&.) :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT # (.\|.) :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT # xor :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT # complement :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT # shift :: ImageCompressionFlagBitsEXT -> Int -> ImageCompressionFlagBitsEXT # rotate :: ImageCompressionFlagBitsEXT -> Int -> ImageCompressionFlagBitsEXT # zeroBits :: ImageCompressionFlagBitsEXT # bit :: Int -> ImageCompressionFlagBitsEXT # setBit :: ImageCompressionFlagBitsEXT -> Int -> ImageCompressionFlagBitsEXT # clearBit :: ImageCompressionFlagBitsEXT -> Int -> ImageCompressionFlagBitsEXT # complementBit :: ImageCompressionFlagBitsEXT -> Int -> ImageCompressionFlagBitsEXT # testBit :: ImageCompressionFlagBitsEXT -> Int -> Bool # bitSizeMaybe :: ImageCompressionFlagBitsEXT -> Maybe Int # bitSize :: ImageCompressionFlagBitsEXT -> Int # isSigned :: ImageCompressionFlagBitsEXT -> Bool # shiftL :: ImageCompressionFlagBitsEXT -> Int -> ImageCompressionFlagBitsEXT # unsafeShiftL :: ImageCompressionFlagBitsEXT -> Int -> ImageCompressionFlagBitsEXT # shiftR :: ImageCompressionFlagBitsEXT -> Int -> ImageCompressionFlagBitsEXT # unsafeShiftR :: ImageCompressionFlagBitsEXT -> Int -> ImageCompressionFlagBitsEXT # rotateL :: ImageCompressionFlagBitsEXT -> Int -> ImageCompressionFlagBitsEXT # rotateR :: ImageCompressionFlagBitsEXT -> Int -> ImageCompressionFlagBitsEXT # popCount :: ImageCompressionFlagBitsEXT -> Int #
FiniteBits ImageCompressionFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods finiteBitSize :: ImageCompressionFlagBitsEXT -> Int # countLeadingZeros :: ImageCompressionFlagBitsEXT -> Int # countTrailingZeros :: ImageCompressionFlagBitsEXT -> Int #
Read ImageCompressionFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods readsPrec :: Int -> ReadS ImageCompressionFlagBitsEXT # readList :: ReadS [ImageCompressionFlagBitsEXT] # readPrec :: ReadPrec ImageCompressionFlagBitsEXT # readListPrec :: ReadPrec [ImageCompressionFlagBitsEXT] #
Show ImageCompressionFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods showsPrec :: Int -> ImageCompressionFlagBitsEXT -> ShowS # show :: ImageCompressionFlagBitsEXT -> String # showList :: [ImageCompressionFlagBitsEXT] -> ShowS #
Eq ImageCompressionFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods (==) :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> Bool # (/=) :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> Bool #
Ord ImageCompressionFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods compare :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> Ordering # (<) :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> Bool # (<=) :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> Bool # (>) :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> Bool # (>=) :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> Bool # max :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT # min :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT #
Zero ImageCompressionFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_image_compression_control Methods zero :: ImageCompressionFlagBitsEXT Source #

Storable ImageSubresource2KHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods sizeOf :: ImageSubresource2KHR -> Int # alignment :: ImageSubresource2KHR -> Int # peekElemOff :: Ptr ImageSubresource2KHR -> Int -> IO ImageSubresource2KHR # pokeElemOff :: Ptr ImageSubresource2KHR -> Int -> ImageSubresource2KHR -> IO () # peekByteOff :: Ptr b -> Int -> IO ImageSubresource2KHR # pokeByteOff :: Ptr b -> Int -> ImageSubresource2KHR -> IO () # peek :: Ptr ImageSubresource2KHR -> IO ImageSubresource2KHR # poke :: Ptr ImageSubresource2KHR -> ImageSubresource2KHR -> IO () #
Show ImageSubresource2KHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods showsPrec :: Int -> ImageSubresource2KHR -> ShowS # show :: ImageSubresource2KHR -> String # showList :: [ImageSubresource2KHR] -> ShowS #
FromCStruct ImageSubresource2KHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods peekCStruct :: Ptr ImageSubresource2KHR -> IO ImageSubresource2KHR Source #
ToCStruct ImageSubresource2KHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods withCStruct :: ImageSubresource2KHR -> (Ptr ImageSubresource2KHR -> IO b) -> IO b Source # pokeCStruct :: Ptr ImageSubresource2KHR -> ImageSubresource2KHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr ImageSubresource2KHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ImageSubresource2KHR -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ImageSubresource2KHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods zero :: ImageSubresource2KHR Source #

PhysicalDeviceImageCompressionControlFeaturesEXT
Fields imageCompressionControl :: Bool `imageCompressionControl` indicates that the implementation supports providing controls for image compression at image creation time.

pattern IMAGE_COMPRESSION_DEFAULT_EXT :: ImageCompressionFlagBitsEXT	`IMAGE_COMPRESSION_DEFAULT_EXT` specifies that the default image compression setting is used. Implementations must not apply fixed-rate compression.
pattern IMAGE_COMPRESSION_FIXED_RATE_DEFAULT_EXT :: ImageCompressionFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_DEFAULT_EXT` specifies that the implementation may choose any supported fixed-rate compression setting in an implementation-defined manner based on the properties of the image.
pattern IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT :: ImageCompressionFlagBitsEXT	`IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT` specifies that fixed-rate compression may be used and that the allowed compression rates are specified by `ImageCompressionControlEXT`::`pFixedRateFlags`.
pattern IMAGE_COMPRESSION_DISABLED_EXT :: ImageCompressionFlagBitsEXT	`IMAGE_COMPRESSION_DISABLED_EXT` specifies that all lossless and fixed-rate compression should be disabled.

ImageSubresource2KHR
Fields imageSubresource :: ImageSubresource `imageSubresource` is a `ImageSubresource` structure. `imageSubresource` must be a valid `ImageSubresource` structure

SubresourceLayout2KHR
Fields next :: Chain es `pNext` is `NULL` or a pointer to a structure extending this structure. subresourceLayout :: SubresourceLayout `subresourceLayout` is a `SubresourceLayout` structure.

Extensible SubresourceLayout2KHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods extensibleTypeName :: String Source # getNext :: forall (es :: [Type]). SubresourceLayout2KHR es -> Chain es Source # setNext :: forall (ds :: [Type]) (es :: [TYPE LiftedRep]). SubresourceLayout2KHR ds -> Chain es -> SubresourceLayout2KHR es Source # extends :: forall e b proxy. Typeable e => proxy e -> (Extends SubresourceLayout2KHR e => b) -> Maybe b Source #
Show (Chain es) => Show (SubresourceLayout2KHR es) Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods showsPrec :: Int -> SubresourceLayout2KHR es -> ShowS # show :: SubresourceLayout2KHR es -> String # showList :: [SubresourceLayout2KHR es] -> ShowS #
(Extendss SubresourceLayout2KHR es, PeekChain es) => FromCStruct (SubresourceLayout2KHR es) Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods peekCStruct :: Ptr (SubresourceLayout2KHR es) -> IO (SubresourceLayout2KHR es) Source #
(Extendss SubresourceLayout2KHR es, PokeChain es) => ToCStruct (SubresourceLayout2KHR es) Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods withCStruct :: SubresourceLayout2KHR es -> (Ptr (SubresourceLayout2KHR es) -> IO b) -> IO b Source # pokeCStruct :: Ptr (SubresourceLayout2KHR es) -> SubresourceLayout2KHR es -> IO b -> IO b Source # withZeroCStruct :: (Ptr (SubresourceLayout2KHR es) -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr (SubresourceLayout2KHR es) -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
es ~ ('[] :: [Type]) => Zero (SubresourceLayout2KHR es) Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods zero :: SubresourceLayout2KHR es Source #

:: forall a io. (Extendss SubresourceLayout2KHR a, PokeChain a, PeekChain a, MonadIO io)
=> Device	`device` is the logical device that owns the image.
-> Image	`image` is the image whose layout is being queried.
-> ImageSubresource2KHR	`pSubresource` is a pointer to a `ImageSubresource2KHR` structure selecting a specific image for the image subresource.
-> io (SubresourceLayout2KHR a)

Name

VK_EXT_image_compression_control

Other Extension Metadata

Description

New Commands

New Structures

New Enums

New Bitmasks

New Enum Constants

Version History

See Also

Document Notes

Documentation

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Members

Description

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Description

See Also

Instances

Description

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also