Vulkan.Extensions.VK_QCOM_rotated_copy_commands

Name

VK_QCOM_rotated_copy_commands - device extension

VK_QCOM_rotated_copy_commands

Name String

VK_QCOM_rotated_copy_commands

Extension Type

Device extension

Registered Extension Number

334

Revision

1

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_swapchain to be enabled for any device-level functionality
• Requires VK_KHR_copy_commands2 to be enabled for any device-level functionality

Contact

• Jeff Leger @jackohound%0A*Here describe the issue or question you have about the VK_QCOM_rotated_copy_commands extension*

Other Extension Metadata

Last Modified Date

2020-09-18

Interactions and External Dependencies

• None

Contributors

• Jeff Leger, Qualcomm Technologies, Inc.

Description

This extension extends adds an optional rotation transform to copy commands cmdBlitImage2KHR, cmdCopyImageToBuffer2KHR and cmdCopyBufferToImage2KHR. When copying between two resources, where one resource contains rotated content and the other does not, a rotated copy may be desired. This extension may be used in combination with VK_QCOM_render_pass_transform which adds rotated render passes.

This extension adds an extension structure to the following commands: vkCmdBlitImage2KHR, vkCmdCopyImageToBuffer2KHR and vkCmdCopyBufferToImage2KHR

Issues

1) What is an appropriate name for the added extension structure? The style guide says “Structures which extend other structures through the pNext chain should reflect the name of the base structure they extend.”, but in this case a single extension structure is used to extend three base structures (vkCmdBlitImage2KHR, vkCmdCopyImageToBuffer2KHR and vkCmdCopyBufferToImage2KHR). Creating three identical structures with unique names seemed undesirable.

RESOLVED: Deviate from the style guide for extension structure naming.

2) Should this extension add a rotation capability to vkCmdCopyImage2KHR?

RESOLVED: No. Use of rotated vkCmdBlitImage2KHR can fully address this use-case.

3) Should this extension add a rotation capability to vkCmdResolveImage2KHR?

RESOLVED No. Use of vkCmdResolveImage2KHR is very slow and extremely bandwidth intensive on Qualcomm’s GPU architecture and use of pResolveAttachments in vkRenderPass is the strongly preferred approach. Therefore, we choose not to introduce a rotation capability to vkCmdResolveImage2KHR.

New Structures

• Extending BufferImageCopy2, ImageBlit2:

  • CopyCommandTransformInfoQCOM

New Enum Constants

• QCOM_ROTATED_COPY_COMMANDS_EXTENSION_NAME

• QCOM_ROTATED_COPY_COMMANDS_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_COPY_COMMAND_TRANSFORM_INFO_QCOM

Version History

• Revision 1, 2020-09-19 (Jeff Leger)

See Also

CopyCommandTransformInfoQCOM

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

data CopyCommandTransformInfoQCOM

VkCopyCommandTransformInfoQCOM - Structure describing transform parameters of rotated copy command

Description

Including this structure in the pNext chain of BufferImageCopy2 defines a rotation to be performed when copying between an image and a buffer. Including this structure in the pNext chain of BlitImageInfo2 defines a rotation to be performed when blitting between two images. If this structure is not specified in either case, the implementation behaves as if it was specified with a transform equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR.

Specifying a transform for a copy between an image and a buffer rotates the region accessed in the image around the offset. Specifying a transform for a blit performs a similar transform as described in Image Blits with Scaling and Rotation.

Rotations other than SURFACE_TRANSFORM_IDENTITY_BIT_KHR can only be specified for single-plane 2D images with a 1x1x1 texel block extent.

Valid Usage (Implicit)

See Also

VK_QCOM_rotated_copy_commands, StructureType, SurfaceTransformFlagBitsKHR

Constructors

CopyCommandTransformInfoQCOM

Fields

• transform :: SurfaceTransformFlagBitsKHR

  transform is a SurfaceTransformFlagBitsKHR value describing the transform to be applied.

  transform must be SURFACE_TRANSFORM_IDENTITY_BIT_KHR, SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, or SURFACE_TRANSFORM_ROTATE_270_BIT_KHR

Instances

Storable CopyCommandTransformInfoQCOM

Defined in Vulkan.Extensions.VK_QCOM_rotated_copy_commands

Methods

sizeOf :: CopyCommandTransformInfoQCOM -> Int

alignment :: CopyCommandTransformInfoQCOM -> Int

peekElemOff :: Ptr CopyCommandTransformInfoQCOM -> Int -> IO CopyCommandTransformInfoQCOM

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

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

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

peek :: Ptr CopyCommandTransformInfoQCOM -> IO CopyCommandTransformInfoQCOM

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

Show CopyCommandTransformInfoQCOM

Defined in Vulkan.Extensions.VK_QCOM_rotated_copy_commands

Methods

showsPrec :: Int -> CopyCommandTransformInfoQCOM -> ShowS

show :: CopyCommandTransformInfoQCOM -> String

showList :: [CopyCommandTransformInfoQCOM] -> ShowS

Eq CopyCommandTransformInfoQCOM

Defined in Vulkan.Extensions.VK_QCOM_rotated_copy_commands

Methods

(==) :: CopyCommandTransformInfoQCOM -> CopyCommandTransformInfoQCOM -> Bool

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

FromCStruct CopyCommandTransformInfoQCOM

Defined in Vulkan.Extensions.VK_QCOM_rotated_copy_commands

Methods

peekCStruct :: Ptr CopyCommandTransformInfoQCOM -> IO CopyCommandTransformInfoQCOM

ToCStruct CopyCommandTransformInfoQCOM

Defined in Vulkan.Extensions.VK_QCOM_rotated_copy_commands

Methods

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

pokeCStruct :: Ptr CopyCommandTransformInfoQCOM -> CopyCommandTransformInfoQCOM -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CopyCommandTransformInfoQCOM -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CopyCommandTransformInfoQCOM

Defined in Vulkan.Extensions.VK_QCOM_rotated_copy_commands

Methods

zero :: CopyCommandTransformInfoQCOM

type QCOM_ROTATED_COPY_COMMANDS_SPEC_VERSION = 1

pattern QCOM_ROTATED_COPY_COMMANDS_SPEC_VERSION :: forall a. Integral a => a

type QCOM_ROTATED_COPY_COMMANDS_EXTENSION_NAME = "VK_QCOM_rotated_copy_commands"

pattern QCOM_ROTATED_COPY_COMMANDS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

newtype SurfaceTransformFlagBitsKHR

VkSurfaceTransformFlagBitsKHR - Presentation transforms supported on a device

See Also

VK_KHR_surface, CommandBufferInheritanceRenderPassTransformInfoQCOM, CopyCommandTransformInfoQCOM, DisplaySurfaceCreateInfoKHR, RenderPassTransformBeginInfoQCOM, SurfaceCapabilities2EXT, SurfaceCapabilitiesKHR, SurfaceTransformFlagsKHR, SwapchainCreateInfoKHR

Constructors

SurfaceTransformFlagBitsKHR Flags

Bundled Patterns

pattern SURFACE_TRANSFORM_IDENTITY_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_IDENTITY_BIT_KHR specifies that image content is presented without being transformed.

pattern SURFACE_TRANSFORM_ROTATE_90_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_ROTATE_90_BIT_KHR specifies that image content is rotated 90 degrees clockwise.

pattern SURFACE_TRANSFORM_ROTATE_180_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_ROTATE_180_BIT_KHR specifies that image content is rotated 180 degrees clockwise.

pattern SURFACE_TRANSFORM_ROTATE_270_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_ROTATE_270_BIT_KHR specifies that image content is rotated 270 degrees clockwise.

pattern SURFACE_TRANSFORM_HORIZONTAL_MIRROR_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_BIT_KHR specifies that image content is mirrored horizontally.

pattern SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR specifies that image content is mirrored horizontally, then rotated 90 degrees clockwise.

pattern SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180_BIT_KHR specifies that image content is mirrored horizontally, then rotated 180 degrees clockwise.

pattern SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR specifies that image content is mirrored horizontally, then rotated 270 degrees clockwise.

pattern SURFACE_TRANSFORM_INHERIT_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_INHERIT_BIT_KHR specifies that the presentation transform is not specified, and is instead determined by platform-specific considerations and mechanisms outside Vulkan.

Instances

Bits SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

(.&.) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR

(.|.) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR

xor :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR

complement :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR

shift :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

rotate :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

zeroBits :: SurfaceTransformFlagBitsKHR

bit :: Int -> SurfaceTransformFlagBitsKHR

setBit :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

clearBit :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

complementBit :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

testBit :: SurfaceTransformFlagBitsKHR -> Int -> Bool

bitSizeMaybe :: SurfaceTransformFlagBitsKHR -> Maybe Int

bitSize :: SurfaceTransformFlagBitsKHR -> Int

isSigned :: SurfaceTransformFlagBitsKHR -> Bool

shiftL :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

unsafeShiftL :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

shiftR :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

unsafeShiftR :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

rotateL :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

rotateR :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

popCount :: SurfaceTransformFlagBitsKHR -> Int

FiniteBits SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

finiteBitSize :: SurfaceTransformFlagBitsKHR -> Int

countLeadingZeros :: SurfaceTransformFlagBitsKHR -> Int

countTrailingZeros :: SurfaceTransformFlagBitsKHR -> Int

Storable SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

sizeOf :: SurfaceTransformFlagBitsKHR -> Int

alignment :: SurfaceTransformFlagBitsKHR -> Int

peekElemOff :: Ptr SurfaceTransformFlagBitsKHR -> Int -> IO SurfaceTransformFlagBitsKHR

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

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

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

peek :: Ptr SurfaceTransformFlagBitsKHR -> IO SurfaceTransformFlagBitsKHR

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

Read SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

readsPrec :: Int -> ReadS SurfaceTransformFlagBitsKHR

readList :: ReadS [SurfaceTransformFlagBitsKHR]

readPrec :: ReadPrec SurfaceTransformFlagBitsKHR

readListPrec :: ReadPrec [SurfaceTransformFlagBitsKHR]

Show SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

showsPrec :: Int -> SurfaceTransformFlagBitsKHR -> ShowS

show :: SurfaceTransformFlagBitsKHR -> String

showList :: [SurfaceTransformFlagBitsKHR] -> ShowS

Eq SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

(==) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> Bool

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

Ord SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

compare :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> Ordering

(<) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> Bool

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

(>) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> Bool

(>=) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> Bool

max :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR

min :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR

Zero SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

zero :: SurfaceTransformFlagBitsKHR

type SurfaceTransformFlagsKHR = SurfaceTransformFlagBitsKHR