Package org.lwjgl.vulkan

Class KHRVideoEncodeQueue

java.lang.Object

org.lwjgl.vulkan.KHRVideoEncodeQueue

public class KHRVideoEncodeQueue
extends java.lang.Object

• CmdEncodeVideoKHR

VK_KHR_video_encode_queue

Name String

VK_KHR_video_encode_queue

Extension Type

Device extension

Registered Extension Number

300

Revision

4

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

• Ahmed Abdelkhalek aabdelkh

Other Extension Metadata

Last Modified Date

2022-02-10

IP Status

No known IP claims.

Contributors

• Ahmed Abdelkhalek, AMD
• Damien Kessler, NVIDIA
• Daniel Rakos, AMD
• George Hao, AMD
• Jake Beju, AMD
• Peter Fang, AMD
• Piers Daniell, NVIDIA
• Srinath Kumarapuram, NVIDIA
• Thomas J. Meier, NVIDIA
• Tony Zlatinski, NVIDIA
• Yang Liu, AMD

Field Summary

Fields

Modifier and Type	Field	Description
static long	VK_ACCESS_2_VIDEO_ENCODE_READ_BIT_KHR VK_ACCESS_2_VIDEO_ENCODE_WRITE_BIT_KHR	Extends VkAccessFlagBits2.
static int	VK_BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR VK_BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR	Extends VkBufferUsageFlagBits.
static long	VK_FORMAT_FEATURE_2_VIDEO_ENCODE_DPB_BIT_KHR VK_FORMAT_FEATURE_2_VIDEO_ENCODE_INPUT_BIT_KHR	Extends VkFormatFeatureFlagBits2.
static int	VK_FORMAT_FEATURE_VIDEO_ENCODE_DPB_BIT_KHR VK_FORMAT_FEATURE_VIDEO_ENCODE_INPUT_BIT_KHR	Extends VkFormatFeatureFlagBits.
static int	VK_IMAGE_LAYOUT_VIDEO_ENCODE_DPB_KHR VK_IMAGE_LAYOUT_VIDEO_ENCODE_DST_KHR VK_IMAGE_LAYOUT_VIDEO_ENCODE_SRC_KHR	Extends VkImageLayout.
static int	VK_IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR VK_IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR VK_IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR	Extends VkImageUsageFlagBits.
static java.lang.String	VK_KHR_VIDEO_ENCODE_QUEUE_EXTENSION_NAME	The extension name.
static int	VK_KHR_VIDEO_ENCODE_QUEUE_SPEC_VERSION	The extension specification version.
static long	VK_PIPELINE_STAGE_2_VIDEO_ENCODE_BIT_KHR	Extends VkPipelineStageFlagBits2.
static int	VK_QUERY_TYPE_VIDEO_ENCODE_BITSTREAM_BUFFER_RANGE_KHR	Extends VkQueryType.
static int	VK_QUEUE_VIDEO_ENCODE_BIT_KHR	Extends VkQueueFlagBits.
static int	VK_STRUCTURE_TYPE_VIDEO_ENCODE_CAPABILITIES_KHR VK_STRUCTURE_TYPE_VIDEO_ENCODE_INFO_KHR VK_STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHR VK_STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_LAYER_INFO_KHR	Extends VkStructureType.
static int	VK_VIDEO_ENCODE_CAPABILITY_DEFAULT_KHR VK_VIDEO_ENCODE_CAPABILITY_PRECEDING_EXTERNALLY_ENCODED_BYTES_BIT_KHR	VkVideoEncodeCapabilityFlagBitsKHR - Video encode capability flags
static int	VK_VIDEO_ENCODE_DEFAULT_KHR	VkVideoEncodeFlagBitsKHR - Video Encode Command Flags
static int	VK_VIDEO_ENCODE_RATE_CONTROL_DEFAULT_KHR	VkVideoEncodeRateControlFlagBitsKHR - Reserved for future use
static int	VK_VIDEO_ENCODE_RATE_CONTROL_MODE_CBR_BIT_KHR VK_VIDEO_ENCODE_RATE_CONTROL_MODE_NONE_BIT_KHR VK_VIDEO_ENCODE_RATE_CONTROL_MODE_VBR_BIT_KHR	VkVideoEncodeRateControlModeFlagBitsKHR - Video encode rate control modes
static int	VK_VIDEO_ENCODE_RATE_CONTROL_RESERVED_0_BIT_KHR	VkVideoEncodeRateControlFlagBitsKHR - Reserved for future use
static int	VK_VIDEO_ENCODE_RESERVED_0_BIT_KHR	VkVideoEncodeFlagBitsKHR - Video Encode Command Flags

Method Summary

Modifier and Type	Method	Description
static void	nvkCmdEncodeVideoKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pEncodeInfo)	Unsafe version of: CmdEncodeVideoKHR
static void	vkCmdEncodeVideoKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkVideoEncodeInfoKHR pEncodeInfo)	Encode operation for bitstream generation.

Methods inherited from class java.lang.Object

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

Field Detail

VK_KHR_VIDEO_ENCODE_QUEUE_SPEC_VERSION

The extension specification version.

VK_KHR_VIDEO_ENCODE_QUEUE_EXTENSION_NAME

The extension name.

VK_PIPELINE_STAGE_2_VIDEO_ENCODE_BIT_KHR

Extends VkPipelineStageFlagBits2.

VK_ACCESS_2_VIDEO_ENCODE_READ_BIT_KHR, VK_ACCESS_2_VIDEO_ENCODE_WRITE_BIT_KHR

Extends VkAccessFlagBits2.

Enum values:

• ACCESS_2_VIDEO_ENCODE_READ_BIT_KHR
• ACCESS_2_VIDEO_ENCODE_WRITE_BIT_KHR

VK_STRUCTURE_TYPE_VIDEO_ENCODE_INFO_KHR, VK_STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHR, VK_STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_LAYER_INFO_KHR, VK_STRUCTURE_TYPE_VIDEO_ENCODE_CAPABILITIES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_VIDEO_ENCODE_INFO_KHR
• STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHR
• STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_LAYER_INFO_KHR
• STRUCTURE_TYPE_VIDEO_ENCODE_CAPABILITIES_KHR

VK_QUEUE_VIDEO_ENCODE_BIT_KHR

Extends VkQueueFlagBits.

VK_BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR, VK_BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR

Extends VkBufferUsageFlagBits.

Enum values:

• BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR
• BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR

VK_IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR, VK_IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR, VK_IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR

Extends VkImageUsageFlagBits.

Enum values:

• IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR
• IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR
• IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR

VK_FORMAT_FEATURE_VIDEO_ENCODE_INPUT_BIT_KHR, VK_FORMAT_FEATURE_VIDEO_ENCODE_DPB_BIT_KHR

Extends VkFormatFeatureFlagBits.

Enum values:

• FORMAT_FEATURE_VIDEO_ENCODE_INPUT_BIT_KHR
• FORMAT_FEATURE_VIDEO_ENCODE_DPB_BIT_KHR

VK_IMAGE_LAYOUT_VIDEO_ENCODE_DST_KHR, VK_IMAGE_LAYOUT_VIDEO_ENCODE_SRC_KHR, VK_IMAGE_LAYOUT_VIDEO_ENCODE_DPB_KHR

Extends VkImageLayout.

Enum values:

• IMAGE_LAYOUT_VIDEO_ENCODE_DST_KHR
• IMAGE_LAYOUT_VIDEO_ENCODE_SRC_KHR
• IMAGE_LAYOUT_VIDEO_ENCODE_DPB_KHR

VK_QUERY_TYPE_VIDEO_ENCODE_BITSTREAM_BUFFER_RANGE_KHR

Extends VkQueryType.

VK_FORMAT_FEATURE_2_VIDEO_ENCODE_INPUT_BIT_KHR, VK_FORMAT_FEATURE_2_VIDEO_ENCODE_DPB_BIT_KHR

Extends VkFormatFeatureFlagBits2.

Enum values:

• FORMAT_FEATURE_2_VIDEO_ENCODE_INPUT_BIT_KHR
• FORMAT_FEATURE_2_VIDEO_ENCODE_DPB_BIT_KHR

VK_VIDEO_ENCODE_DEFAULT_KHR, VK_VIDEO_ENCODE_RESERVED_0_BIT_KHR

VkVideoEncodeFlagBitsKHR - Video Encode Command Flags

Description

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

Enum values:

• VIDEO_ENCODE_DEFAULT_KHR

VK_VIDEO_ENCODE_CAPABILITY_DEFAULT_KHR, VK_VIDEO_ENCODE_CAPABILITY_PRECEDING_EXTERNALLY_ENCODED_BYTES_BIT_KHR

VkVideoEncodeCapabilityFlagBitsKHR - Video encode capability flags

Description

• VIDEO_ENCODE_CAPABILITY_PRECEDING_EXTERNALLY_ENCODED_BYTES_BIT_KHR reports that the implementation supports use of VkVideoEncodeInfoKHR::precedingExternallyEncodedBytes.

Enum values:

• VIDEO_ENCODE_CAPABILITY_DEFAULT_KHR

VK_VIDEO_ENCODE_RATE_CONTROL_MODE_NONE_BIT_KHR, VK_VIDEO_ENCODE_RATE_CONTROL_MODE_CBR_BIT_KHR, VK_VIDEO_ENCODE_RATE_CONTROL_MODE_VBR_BIT_KHR

VkVideoEncodeRateControlModeFlagBitsKHR - Video encode rate control modes

Description

• VIDEO_ENCODE_RATE_CONTROL_MODE_NONE_BIT_KHR for disabling rate control.
• VIDEO_ENCODE_RATE_CONTROL_MODE_CBR_BIT_KHR for constant bitrate rate control mode.
• VIDEO_ENCODE_RATE_CONTROL_MODE_VBR_BIT_KHR for variable bitrate rate control mode.

See Also

VkVideoEncodeRateControlInfoKHR

VK_VIDEO_ENCODE_RATE_CONTROL_DEFAULT_KHR, VK_VIDEO_ENCODE_RATE_CONTROL_RESERVED_0_BIT_KHR

VkVideoEncodeRateControlFlagBitsKHR - Reserved for future use

Description

VkVideoEncodeRateControlFlagBitsKHR defines bits which may be set in a VkVideoEncodeRateControlFlagsKHR value, but is currently unused.

Enum values:

• VIDEO_ENCODE_RATE_CONTROL_DEFAULT_KHR
• VIDEO_ENCODE_RATE_CONTROL_RESERVED_0_BIT_KHR

Method Detail

nvkCmdEncodeVideoKHR

public static void nvkCmdEncodeVideoKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                        long pEncodeInfo)

Unsafe version of: CmdEncodeVideoKHR

vkCmdEncodeVideoKHR

public static void vkCmdEncodeVideoKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                       VkVideoEncodeInfoKHR pEncodeInfo)

Encode operation for bitstream generation.

C Specification

To launch an encode operation that results in bitstream generation, call:

 void vkCmdEncodeVideoKHR(
     VkCommandBuffer                             commandBuffer,
     const VkVideoEncodeInfoKHR*                 pEncodeInfo);

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pEncodeInfo must be a valid pointer to a valid VkVideoEncodeInfoKHR structure
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support encode 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	Encode

See Also

VkVideoEncodeInfoKHR

Parameters:

commandBuffer - the command buffer to be filled with this function for encoding to generate a bitstream.

pEncodeInfo - a pointer to a VkVideoEncodeInfoKHR structure.