Package org.lwjgl.vulkan

Class KHRVideoDecodeQueue

java.lang.Object

org.lwjgl.vulkan.KHRVideoDecodeQueue

public class KHRVideoDecodeQueue
extends java.lang.Object

• CmdDecodeVideoKHR

VK_KHR_video_decode_queue

Name String

VK_KHR_video_decode_queue

Extension Type

Device extension

Registered Extension Number

25

Revision

2

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_video_queue
• Requires VK_KHR_synchronization2
• This is a provisional extension and must be used with caution. See the description of provisional header files for enablement and stability details.

Contact

• jake.beju@amd.com

Other Extension Metadata

Last Modified Date

2021-09-30

IP Status

No known IP claims.

Contributors

• Jake Beju, AMD
• Olivier Lapicque, NVIDIA
• Peter Fang, AMD
• Piers Daniell, NVIDIA
• Srinath Kumarapuram, NVIDIA
• Tony Zlatinski, NVIDIA

Field Summary

Fields

Modifier and Type	Field	Description
static long	VK_ACCESS_2_VIDEO_DECODE_READ_BIT_KHR VK_ACCESS_2_VIDEO_DECODE_WRITE_BIT_KHR	Extends VkAccessFlagBits2.
static int	VK_BUFFER_USAGE_VIDEO_DECODE_DST_BIT_KHR VK_BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR	Extends VkBufferUsageFlagBits.
static long	VK_FORMAT_FEATURE_2_VIDEO_DECODE_DPB_BIT_KHR VK_FORMAT_FEATURE_2_VIDEO_DECODE_OUTPUT_BIT_KHR	Extends VkFormatFeatureFlagBits2.
static int	VK_FORMAT_FEATURE_VIDEO_DECODE_DPB_BIT_KHR VK_FORMAT_FEATURE_VIDEO_DECODE_OUTPUT_BIT_KHR	Extends VkFormatFeatureFlagBits.
static int	VK_IMAGE_LAYOUT_VIDEO_DECODE_DPB_KHR VK_IMAGE_LAYOUT_VIDEO_DECODE_DST_KHR VK_IMAGE_LAYOUT_VIDEO_DECODE_SRC_KHR	Extends VkImageLayout.
static int	VK_IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR VK_IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR VK_IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR	Extends VkImageUsageFlagBits.
static java.lang.String	VK_KHR_VIDEO_DECODE_QUEUE_EXTENSION_NAME	The extension name.
static int	VK_KHR_VIDEO_DECODE_QUEUE_SPEC_VERSION	The extension specification version.
static long	VK_PIPELINE_STAGE_2_VIDEO_DECODE_BIT_KHR	Extends VkPipelineStageFlagBits2.
static int	VK_QUEUE_VIDEO_DECODE_BIT_KHR	Extends VkQueueFlagBits.
static int	VK_STRUCTURE_TYPE_VIDEO_DECODE_INFO_KHR	Extends VkStructureType.
static int	VK_VIDEO_DECODE_DEFAULT_KHR VK_VIDEO_DECODE_RESERVED_0_BIT_KHR	VkVideoDecodeFlagBitsKHR - Video Decode Command Flags

Method Summary

Modifier and Type	Method	Description
static void	nvkCmdDecodeVideoKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pFrameInfo)	Unsafe version of: CmdDecodeVideoKHR
static void	vkCmdDecodeVideoKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkVideoDecodeInfoKHR pFrameInfo)	Decode a frame.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VK_KHR_VIDEO_DECODE_QUEUE_SPEC_VERSION

The extension specification version.

VK_KHR_VIDEO_DECODE_QUEUE_EXTENSION_NAME

The extension name.

VK_STRUCTURE_TYPE_VIDEO_DECODE_INFO_KHR

Extends VkStructureType.

VK_QUEUE_VIDEO_DECODE_BIT_KHR

Extends VkQueueFlagBits.

VK_PIPELINE_STAGE_2_VIDEO_DECODE_BIT_KHR

Extends VkPipelineStageFlagBits2.

VK_ACCESS_2_VIDEO_DECODE_READ_BIT_KHR, VK_ACCESS_2_VIDEO_DECODE_WRITE_BIT_KHR

Extends VkAccessFlagBits2.

Enum values:

• ACCESS_2_VIDEO_DECODE_READ_BIT_KHR
• ACCESS_2_VIDEO_DECODE_WRITE_BIT_KHR

VK_BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR, VK_BUFFER_USAGE_VIDEO_DECODE_DST_BIT_KHR

Extends VkBufferUsageFlagBits.

Enum values:

• BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR
• BUFFER_USAGE_VIDEO_DECODE_DST_BIT_KHR

VK_IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR, VK_IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR, VK_IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR

Extends VkImageUsageFlagBits.

Enum values:

• IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR
• IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR
• IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR

VK_FORMAT_FEATURE_VIDEO_DECODE_OUTPUT_BIT_KHR, VK_FORMAT_FEATURE_VIDEO_DECODE_DPB_BIT_KHR

Extends VkFormatFeatureFlagBits.

Enum values:

• FORMAT_FEATURE_VIDEO_DECODE_OUTPUT_BIT_KHR
• FORMAT_FEATURE_VIDEO_DECODE_DPB_BIT_KHR

VK_IMAGE_LAYOUT_VIDEO_DECODE_DST_KHR, VK_IMAGE_LAYOUT_VIDEO_DECODE_SRC_KHR, VK_IMAGE_LAYOUT_VIDEO_DECODE_DPB_KHR

Extends VkImageLayout.

Enum values:

• IMAGE_LAYOUT_VIDEO_DECODE_DST_KHR
• IMAGE_LAYOUT_VIDEO_DECODE_SRC_KHR
• IMAGE_LAYOUT_VIDEO_DECODE_DPB_KHR

VK_FORMAT_FEATURE_2_VIDEO_DECODE_OUTPUT_BIT_KHR, VK_FORMAT_FEATURE_2_VIDEO_DECODE_DPB_BIT_KHR

Extends VkFormatFeatureFlagBits2.

Enum values:

• FORMAT_FEATURE_2_VIDEO_DECODE_OUTPUT_BIT_KHR
• FORMAT_FEATURE_2_VIDEO_DECODE_DPB_BIT_KHR

VK_VIDEO_DECODE_DEFAULT_KHR, VK_VIDEO_DECODE_RESERVED_0_BIT_KHR

VkVideoDecodeFlagBitsKHR - Video Decode Command Flags

Description

• VIDEO_DECODE_RESERVED_0_BIT_KHR The current version of the specification has reserved this value for future use.

Enum values:

• VIDEO_DECODE_DEFAULT_KHR

Method Detail

nvkCmdDecodeVideoKHR

public static void nvkCmdDecodeVideoKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                        long pFrameInfo)

Unsafe version of: CmdDecodeVideoKHR

vkCmdDecodeVideoKHR

public static void vkCmdDecodeVideoKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                       VkVideoDecodeInfoKHR pFrameInfo)

Decode a frame.

C Specification

To decode a frame, call:

 void vkCmdDecodeVideoKHR(
     VkCommandBuffer                             commandBuffer,
     const VkVideoDecodeInfoKHR*                 pFrameInfo);

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pFrameInfo must be a valid pointer to a valid VkVideoDecodeInfoKHR structure
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support decode operations
• This command must only be called outside of a render pass instance
• commandBuffer must be a primary VkCommandBuffer

Host Synchronization

• Host access to the VkCommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary	Outside	Decode

See Also

VkVideoDecodeInfoKHR

Parameters:

commandBuffer - the command buffer to be filled with this function for decode frame command.

pFrameInfo - a pointer to a VkVideoDecodeInfoKHR structure.