Vulkan.Extensions.VK_EXT_image_compression_control

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

Extension and Version Dependencies

• Requires support for Vulkan 1.0

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, SubresourceLayout2EXT:

  • ImageCompressionPropertiesEXT

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceImageCompressionControlFeaturesEXT

New Enums

• ImageCompressionFixedRateFlagBitsEXT

• ImageCompressionFlagBitsEXT

New Bitmasks

• ImageCompressionFixedRateFlagsEXT

• ImageCompressionFlagsEXT

New Enum Constants

• EXT_IMAGE_COMPRESSION_CONTROL_EXTENSION_NAME

• EXT_IMAGE_COMPRESSION_CONTROL_SPEC_VERSION

• Extending Result:

  • ERROR_COMPRESSION_EXHAUSTED_EXT

• Extending StructureType:

  • STRUCTURE_TYPE_IMAGE_COMPRESSION_CONTROL_EXT
  • STRUCTURE_TYPE_IMAGE_COMPRESSION_PROPERTIES_EXT
  • STRUCTURE_TYPE_IMAGE_SUBRESOURCE_2_EXT
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_COMPRESSION_CONTROL_FEATURES_EXT
  • STRUCTURE_TYPE_SUBRESOURCE_LAYOUT_2_EXT

Version History

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

  • Initial draft

See Also

ImageCompressionControlEXT, ImageCompressionFixedRateFlagBitsEXT, ImageCompressionFixedRateFlagsEXT, ImageCompressionFlagBitsEXT, ImageCompressionFlagsEXT, ImageCompressionPropertiesEXT, ImageSubresource2EXT, PhysicalDeviceImageCompressionControlFeaturesEXT, SubresourceLayout2EXT, getImageSubresourceLayout2EXT

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.

Documentation

getImageSubresourceLayout2EXT

Arguments

:: forall a io. (Extendss SubresourceLayout2EXT 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.

-> ImageSubresource2EXT

pSubresource is a pointer to a ImageSubresource2EXT structure selecting a specific image for the image subresource.

-> io (SubresourceLayout2EXT a)

vkGetImageSubresourceLayout2EXT - Retrieve information about an image subresource

Description

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

Valid Usage

• image must have been created with tiling equal to IMAGE_TILING_LINEAR or IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT

• 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 is a color format, the aspectMask member of pSubresource must be IMAGE_ASPECT_COLOR_BIT
• If format has a depth component, the aspectMask member of pSubresource must contain IMAGE_ASPECT_DEPTH_BIT
• If format has a stencil component, the aspectMask member of pSubresource must contain IMAGE_ASPECT_STENCIL_BIT
• If format 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 its format is a multi-planar format with two planes, the aspectMask member of pSubresource must be IMAGE_ASPECT_PLANE_0_BIT or IMAGE_ASPECT_PLANE_1_BIT
• If the tiling of the image is IMAGE_TILING_LINEAR and its format is a multi-planar format with three planes, the aspectMask member of pSubresource must be IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT or IMAGE_ASPECT_PLANE_2_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 ImageSubresource2EXT structure
• pLayout must be a valid pointer to a SubresourceLayout2EXT structure
• image must have been created, allocated, or retrieved from device

See Also

VK_EXT_image_compression_control, Device, Image, ImageSubresource2EXT, SubresourceLayout2EXT

data ImageCompressionControlEXT

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.

See Also

VK_EXT_image_compression_control, ImageCompressionFixedRateFlagsEXT, ImageCompressionFlagsEXT, StructureType

Constructors

ImageCompressionControlEXT

Fields

• flags :: ImageCompressionFlagsEXT

  flags is a bitmask of ImageCompressionFlagBitsEXT describing compression controls for the image.

• compressionControlPlaneCount :: Word32

  compressionControlPlaneCount is the number of entries in the pFixedRateFlags array.

• fixedRateFlags :: Ptr ImageCompressionFixedRateFlagsEXT

  pFixedRateFlags is NULL or a pointer to an array of ImageCompressionFixedRateFlagsEXT bitfields describing allowed fixed-rate compression rates of each image plane. It is ignored if flags does not include IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT.

Instances

Storable ImageCompressionControlEXT

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

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

showsPrec :: Int -> ImageCompressionControlEXT -> ShowS

show :: ImageCompressionControlEXT -> String

showList :: [ImageCompressionControlEXT] -> ShowS

Eq ImageCompressionControlEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

(==) :: ImageCompressionControlEXT -> ImageCompressionControlEXT -> Bool

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

FromCStruct ImageCompressionControlEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

peekCStruct :: Ptr ImageCompressionControlEXT -> IO ImageCompressionControlEXT

ToCStruct ImageCompressionControlEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

withCStruct :: ImageCompressionControlEXT -> (Ptr ImageCompressionControlEXT -> IO b) -> IO b

pokeCStruct :: Ptr ImageCompressionControlEXT -> ImageCompressionControlEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ImageCompressionControlEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImageCompressionControlEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImageCompressionControlEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

zero :: ImageCompressionControlEXT

data PhysicalDeviceImageCompressionControlFeaturesEXT

VkPhysicalDeviceImageCompressionControlFeaturesEXT - Structure describing whether image compression controls can be supported by an implementation

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)

See Also

VK_EXT_image_compression_control, Bool32, StructureType

Constructors

PhysicalDeviceImageCompressionControlFeaturesEXT

Fields

• imageCompressionControl :: Bool

  imageCompressionControl indicates that the implementation supports providing controls for image compression at image creation time.

Instances

Storable PhysicalDeviceImageCompressionControlFeaturesEXT

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

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

showsPrec :: Int -> PhysicalDeviceImageCompressionControlFeaturesEXT -> ShowS

show :: PhysicalDeviceImageCompressionControlFeaturesEXT -> String

showList :: [PhysicalDeviceImageCompressionControlFeaturesEXT] -> ShowS

Eq PhysicalDeviceImageCompressionControlFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

(==) :: PhysicalDeviceImageCompressionControlFeaturesEXT -> PhysicalDeviceImageCompressionControlFeaturesEXT -> Bool

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

FromCStruct PhysicalDeviceImageCompressionControlFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

peekCStruct :: Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> IO PhysicalDeviceImageCompressionControlFeaturesEXT

ToCStruct PhysicalDeviceImageCompressionControlFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

withCStruct :: PhysicalDeviceImageCompressionControlFeaturesEXT -> (Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> PhysicalDeviceImageCompressionControlFeaturesEXT -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceImageCompressionControlFeaturesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceImageCompressionControlFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

zero :: PhysicalDeviceImageCompressionControlFeaturesEXT

data ImageCompressionPropertiesEXT

VkImageCompressionPropertiesEXT - Compression properties of an image

Valid Usage (Implicit)

See Also

VK_EXT_image_compression_control, ImageCompressionFixedRateFlagsEXT, ImageCompressionFlagsEXT, StructureType

Constructors

ImageCompressionPropertiesEXT

Fields

• imageCompressionFlags :: ImageCompressionFlagsEXT

  imageCompressionFlags returns a value describing the compression controls that apply to the image. The value will be either IMAGE_COMPRESSION_DEFAULT_EXT to indicate no fixed-rate compression, IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT to indicate fixed-rate compression, or IMAGE_COMPRESSION_DISABLED_EXT to indicate no compression.

• imageCompressionFixedRateFlags :: ImageCompressionFixedRateFlagsEXT

  imageCompressionFixedRateFlags returns a ImageCompressionFixedRateFlagsEXT value describing the compression rates that apply to the specified aspect of the image.

Instances

Storable ImageCompressionPropertiesEXT

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

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

showsPrec :: Int -> ImageCompressionPropertiesEXT -> ShowS

show :: ImageCompressionPropertiesEXT -> String

showList :: [ImageCompressionPropertiesEXT] -> ShowS

Eq ImageCompressionPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

(==) :: ImageCompressionPropertiesEXT -> ImageCompressionPropertiesEXT -> Bool

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

FromCStruct ImageCompressionPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

peekCStruct :: Ptr ImageCompressionPropertiesEXT -> IO ImageCompressionPropertiesEXT

ToCStruct ImageCompressionPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

withCStruct :: ImageCompressionPropertiesEXT -> (Ptr ImageCompressionPropertiesEXT -> IO b) -> IO b

pokeCStruct :: Ptr ImageCompressionPropertiesEXT -> ImageCompressionPropertiesEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ImageCompressionPropertiesEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImageCompressionPropertiesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImageCompressionPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

zero :: ImageCompressionPropertiesEXT

data ImageSubresource2EXT

VkImageSubresource2EXT - Structure specifying an image subresource

Valid Usage (Implicit)

See Also

VK_EXT_image_compression_control, ImageSubresource, StructureType, getImageSubresourceLayout2EXT

Constructors

ImageSubresource2EXT

Fields

• imageSubresource :: ImageSubresource

  imageSubresource is a ImageSubresource structure.

  imageSubresource must be a valid ImageSubresource structure

Instances

Storable ImageSubresource2EXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

sizeOf :: ImageSubresource2EXT -> Int

alignment :: ImageSubresource2EXT -> Int

peekElemOff :: Ptr ImageSubresource2EXT -> Int -> IO ImageSubresource2EXT

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

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

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

peek :: Ptr ImageSubresource2EXT -> IO ImageSubresource2EXT

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

Show ImageSubresource2EXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

showsPrec :: Int -> ImageSubresource2EXT -> ShowS

show :: ImageSubresource2EXT -> String

showList :: [ImageSubresource2EXT] -> ShowS

FromCStruct ImageSubresource2EXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

peekCStruct :: Ptr ImageSubresource2EXT -> IO ImageSubresource2EXT

ToCStruct ImageSubresource2EXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

withCStruct :: ImageSubresource2EXT -> (Ptr ImageSubresource2EXT -> IO b) -> IO b

pokeCStruct :: Ptr ImageSubresource2EXT -> ImageSubresource2EXT -> IO b -> IO b

withZeroCStruct :: (Ptr ImageSubresource2EXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImageSubresource2EXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImageSubresource2EXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

zero :: ImageSubresource2EXT

data SubresourceLayout2EXT (es :: [Type])

VkSubresourceLayout2EXT - Structure specifying subresource layout

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SUBRESOURCE_LAYOUT_2_EXT

• pNext must be NULL or a pointer to a valid instance of ImageCompressionPropertiesEXT
• The sType value of each struct in the pNext chain must be unique

See Also

VK_EXT_image_compression_control, StructureType, SubresourceLayout, getImageSubresourceLayout2EXT

Constructors

SubresourceLayout2EXT

Fields

• next :: Chain es

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

• subresourceLayout :: SubresourceLayout

  subresourceLayout is a SubresourceLayout structure.

Instances

Extensible SubresourceLayout2EXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

extensibleTypeName :: String

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

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

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

Show (Chain es) => Show (SubresourceLayout2EXT es)

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

showsPrec :: Int -> SubresourceLayout2EXT es -> ShowS

show :: SubresourceLayout2EXT es -> String

showList :: [SubresourceLayout2EXT es] -> ShowS

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

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

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

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

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

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

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

zero :: SubresourceLayout2EXT es

type ImageCompressionFlagsEXT = ImageCompressionFlagBitsEXT

newtype ImageCompressionFlagBitsEXT

VkImageCompressionFlagBitsEXT - Bitmask specifying image compression controls

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.

See Also

VK_EXT_image_compression_control, ImageCompressionFlagsEXT

Constructors

ImageCompressionFlagBitsEXT Flags

Bundled Patterns

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.

Instances

Bits ImageCompressionFlagBitsEXT

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

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

finiteBitSize :: ImageCompressionFlagBitsEXT -> Int

countLeadingZeros :: ImageCompressionFlagBitsEXT -> Int

countTrailingZeros :: ImageCompressionFlagBitsEXT -> Int

Storable ImageCompressionFlagBitsEXT

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 ()

Read ImageCompressionFlagBitsEXT

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

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

showsPrec :: Int -> ImageCompressionFlagBitsEXT -> ShowS

show :: ImageCompressionFlagBitsEXT -> String

showList :: [ImageCompressionFlagBitsEXT] -> ShowS

Eq ImageCompressionFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

(==) :: ImageCompressionFlagBitsEXT -> ImageCompressionFlagBitsEXT -> Bool

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

Ord ImageCompressionFlagBitsEXT

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

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

zero :: ImageCompressionFlagBitsEXT

type ImageCompressionFixedRateFlagsEXT = ImageCompressionFixedRateFlagBitsEXT

newtype ImageCompressionFixedRateFlagBitsEXT

VkImageCompressionFixedRateFlagBitsEXT - Bitmask specifying fixed rate image compression rates

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.

See Also

VK_EXT_image_compression_control, ImageCompressionFixedRateFlagsEXT

Constructors

ImageCompressionFixedRateFlagBitsEXT Flags

Bundled Patterns

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

Bits ImageCompressionFixedRateFlagBitsEXT

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

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

finiteBitSize :: ImageCompressionFixedRateFlagBitsEXT -> Int

countLeadingZeros :: ImageCompressionFixedRateFlagBitsEXT -> Int

countTrailingZeros :: ImageCompressionFixedRateFlagBitsEXT -> Int

Storable ImageCompressionFixedRateFlagBitsEXT

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 ()

Read ImageCompressionFixedRateFlagBitsEXT

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

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

showsPrec :: Int -> ImageCompressionFixedRateFlagBitsEXT -> ShowS

show :: ImageCompressionFixedRateFlagBitsEXT -> String

showList :: [ImageCompressionFixedRateFlagBitsEXT] -> ShowS

Eq ImageCompressionFixedRateFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

(==) :: ImageCompressionFixedRateFlagBitsEXT -> ImageCompressionFixedRateFlagBitsEXT -> Bool

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

Ord ImageCompressionFixedRateFlagBitsEXT

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

Defined in Vulkan.Extensions.VK_EXT_image_compression_control

Methods

zero :: ImageCompressionFixedRateFlagBitsEXT

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