Top Description Fields Constructors Methods
org.lwjgl.vulkan

public Class KHRVideoEncodeQueue

extends Object
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

This extension builds upon the VK_KHR_video_queue extension by adding common APIs specific to video encoding and thus enabling implementations to expose queue families supporting video encode operations.

More specifically, it adds video encode specific capabilities and a new command buffer command that allows recording video encode operations against a video session.

This extension is to be used in conjunction with other codec specific video encode extensions that enable encoding video sequences of specific video compression standards.

VK_KHR_video_encode_queue
Name String
VK_KHR_video_encode_queue
Extension Type
Device extension
Registered Extension Number
300
Revision
10
Extension and Version Dependencies
VK_KHR_video_queue and 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
Other Extension Metadata
Last Modified Date
2023-07-19
IP Status
No known IP claims.
Contributors
  • Ahmed Abdelkhalek, AMD
  • Damien Kessler, NVIDIA
  • George Hao, AMD
  • Jake Beju, AMD
  • Peter Fang, AMD
  • Piers Daniell, NVIDIA
  • Srinath Kumarapuram, NVIDIA
  • Thomas J. Meier, NVIDIA
  • Tony Zlatinski, NVIDIA
  • Ravi Chaudhary, NVIDIA
  • Yang Liu, AMD
  • Daniel Rakos, RasterGrid
  • Ping Liu, Intel
  • Aidan Fabius, Core Avionics & Industrial Inc.

Field Summary

Modifier and TypeField and Description
public static final long
VK_ACCESS_2_VIDEO_ENCODE_READ_BIT_KHR

Extends VkAccessFlagBits2.

public static final long
VK_ACCESS_2_VIDEO_ENCODE_WRITE_BIT_KHR

Extends VkAccessFlagBits2.

public static final int
VK_BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR

Extends VkBufferUsageFlagBits.

public static final int
VK_BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR

Extends VkBufferUsageFlagBits.

public static final int
public static final long
VK_FORMAT_FEATURE_2_VIDEO_ENCODE_DPB_BIT_KHR

Extends VkFormatFeatureFlagBits2.

public static final long
VK_FORMAT_FEATURE_2_VIDEO_ENCODE_INPUT_BIT_KHR

Extends VkFormatFeatureFlagBits2.

public static final int
VK_FORMAT_FEATURE_VIDEO_ENCODE_DPB_BIT_KHR

Extends VkFormatFeatureFlagBits.

public static final int
VK_FORMAT_FEATURE_VIDEO_ENCODE_INPUT_BIT_KHR

Extends VkFormatFeatureFlagBits.

public static final int
public static final int
public static final int
public static final int
VK_IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR

Extends VkImageUsageFlagBits.

public static final int
VK_IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR

Extends VkImageUsageFlagBits.

public static final int
VK_IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR

Extends VkImageUsageFlagBits.

public static final String
public static final int
VK_KHR_VIDEO_ENCODE_QUEUE_SPEC_VERSION

The extension specification version.

public static final long
VK_PIPELINE_STAGE_2_VIDEO_ENCODE_BIT_KHR

Extends VkPipelineStageFlagBits2.

public static final int
public static final int
public static final int
VK_QUEUE_VIDEO_ENCODE_BIT_KHR

Extends VkQueueFlagBits.

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
VK_VIDEO_CODING_CONTROL_ENCODE_QUALITY_LEVEL_BIT_KHR

Extends VkVideoCodingControlFlagBitsKHR.

public static final int
VK_VIDEO_CODING_CONTROL_ENCODE_RATE_CONTROL_BIT_KHR

Extends VkVideoCodingControlFlagBitsKHR.

public static final int
VK_VIDEO_ENCODE_CAPABILITY_INSUFFICIENT_BITSTREAM_BUFFER_RANGE_DETECTION_BIT_KHR

VkVideoEncodeCapabilityFlagBitsKHR - Video encode capability flags Description

public static final int
VK_VIDEO_ENCODE_CAPABILITY_PRECEDING_EXTERNALLY_ENCODED_BYTES_BIT_KHR

VkVideoEncodeCapabilityFlagBitsKHR - Video encode capability flags Description

public static final int
VK_VIDEO_ENCODE_CONTENT_CAMERA_BIT_KHR

VkVideoEncodeContentFlagBitsKHR - Video encode content flags Description

public static final int
VK_VIDEO_ENCODE_CONTENT_DEFAULT_KHR

VkVideoEncodeContentFlagBitsKHR - Video encode content flags Description

public static final int
VK_VIDEO_ENCODE_CONTENT_DESKTOP_BIT_KHR

VkVideoEncodeContentFlagBitsKHR - Video encode content flags Description

public static final int
VK_VIDEO_ENCODE_CONTENT_RENDERED_BIT_KHR

VkVideoEncodeContentFlagBitsKHR - Video encode content flags Description

public static final int
VK_VIDEO_ENCODE_FEEDBACK_BITSTREAM_BUFFER_OFFSET_BIT_KHR

VkVideoEncodeFeedbackFlagBitsKHR - Bits specifying queried video encode feedback values Description

public static final int
VK_VIDEO_ENCODE_FEEDBACK_BITSTREAM_BYTES_WRITTEN_BIT_KHR

VkVideoEncodeFeedbackFlagBitsKHR - Bits specifying queried video encode feedback values Description

public static final int
VK_VIDEO_ENCODE_FEEDBACK_BITSTREAM_HAS_OVERRIDES_BIT_KHR

VkVideoEncodeFeedbackFlagBitsKHR - Bits specifying queried video encode feedback values Description

public static final int
VK_VIDEO_ENCODE_RATE_CONTROL_MODE_CBR_BIT_KHR

VkVideoEncodeRateControlModeFlagBitsKHR - Video encode rate control modes Description

public static final int
VK_VIDEO_ENCODE_RATE_CONTROL_MODE_DEFAULT_KHR

VkVideoEncodeRateControlModeFlagBitsKHR - Video encode rate control modes Description

public static final int
VK_VIDEO_ENCODE_RATE_CONTROL_MODE_DISABLED_BIT_KHR

VkVideoEncodeRateControlModeFlagBitsKHR - Video encode rate control modes Description

public static final int
VK_VIDEO_ENCODE_RATE_CONTROL_MODE_VBR_BIT_KHR

VkVideoEncodeRateControlModeFlagBitsKHR - Video encode rate control modes Description

public static final int
VK_VIDEO_ENCODE_TUNING_MODE_DEFAULT_KHR

VkVideoEncodeTuningModeKHR - Video encode tuning mode Description

public static final int
VK_VIDEO_ENCODE_TUNING_MODE_HIGH_QUALITY_KHR

VkVideoEncodeTuningModeKHR - Video encode tuning mode Description

public static final int
VK_VIDEO_ENCODE_TUNING_MODE_LOSSLESS_KHR

VkVideoEncodeTuningModeKHR - Video encode tuning mode Description

public static final int
VK_VIDEO_ENCODE_TUNING_MODE_LOW_LATENCY_KHR

VkVideoEncodeTuningModeKHR - Video encode tuning mode Description

public static final int
VK_VIDEO_ENCODE_TUNING_MODE_ULTRA_LOW_LATENCY_KHR

VkVideoEncodeTuningModeKHR - Video encode tuning mode Description

public static final int
VK_VIDEO_ENCODE_USAGE_CONFERENCING_BIT_KHR

VkVideoEncodeUsageFlagBitsKHR - Video encode usage flags Description

public static final int
VK_VIDEO_ENCODE_USAGE_DEFAULT_KHR

VkVideoEncodeUsageFlagBitsKHR - Video encode usage flags Description

public static final int
VK_VIDEO_ENCODE_USAGE_RECORDING_BIT_KHR

VkVideoEncodeUsageFlagBitsKHR - Video encode usage flags Description

public static final int
VK_VIDEO_ENCODE_USAGE_STREAMING_BIT_KHR

VkVideoEncodeUsageFlagBitsKHR - Video encode usage flags Description

public static final int
VK_VIDEO_ENCODE_USAGE_TRANSCODING_BIT_KHR

VkVideoEncodeUsageFlagBitsKHR - Video encode usage flags Description

public static final int

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public static void
nvkCmdEncodeVideoKHR(VkCommandBuffer commandBuffer, long pEncodeInfo)

Unsafe version of: CmdEncodeVideoKHR

public static int
nvkGetEncodedVideoSessionParametersKHR(VkDevice device, long pVideoSessionParametersInfo, long pFeedbackInfo, long
a pointer to a size_t value related to the amount of encode parameter data returned, as described below.
pDataSize
,
long pData)

Unsafe version of: GetEncodedVideoSessionParametersKHR

public static int
nvkGetPhysicalDeviceVideoEncodeQualityLevelPropertiesKHR(VkPhysicalDevice physicalDevice, long pQualityLevelInfo, long pQualityLevelProperties)

Unsafe version of: GetPhysicalDeviceVideoEncodeQualityLevelPropertiesKHR

public static void
vkCmdEncodeVideoKHR(VkCommandBuffer
the command buffer to be filled with this function for encoding to generate a bitstream.
commandBuffer
,
VkVideoEncodeInfoKHR
a pointer to a VkVideoEncodeInfoKHR structure.
pEncodeInfo
)

Encode operation for bitstream generation.

public static int
vkGetEncodedVideoSessionParametersKHR(VkDevice
the logical device that owns the video session parameters object.
device
,
VkVideoEncodeSessionParametersGetInfoKHR
a pointer to a VkVideoEncodeSessionParametersGetInfoKHR structure specifying the parameters of the encoded parameter data to retrieve.
pVideoSessionParametersInfo
,
VkVideoEncodeSessionParametersFeedbackInfoKHR
either NULL or a pointer to a VkVideoEncodeSessionParametersFeedbackInfoKHR structure in which feedback about the requested parameter data is returned.
pFeedbackInfo
,
PointerBuffer
a pointer to a size_t value related to the amount of encode parameter data returned, as described below.
pDataSize
,
ByteBuffer
either NULL or a pointer to a buffer to write the encoded parameter data to.
pData
)

Get encoded parameter sets from a video session parameters object.

public static int
vkGetPhysicalDeviceVideoEncodeQualityLevelPropertiesKHR(VkPhysicalDevice
the physical device to query the video encode quality level properties for.
physicalDevice
,
VkPhysicalDeviceVideoEncodeQualityLevelInfoKHR
a pointer to a VkPhysicalDeviceVideoEncodeQualityLevelInfoKHR structure specifying the video encode profile and quality level to query properties for.
pQualityLevelInfo
,
VkVideoEncodeQualityLevelPropertiesKHR
a pointer to a VkVideoEncodeQualityLevelPropertiesKHR structure in which the properties are returned.
pQualityLevelProperties
)

Query video encode quality level properties.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait