Top Description Fields Constructors Methods
org.lwjgl.vulkan

public Class KHRVideoQueue

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

This extension provides common APIs to enable exposing queue families with support for video codec operations by introducing the following new object types and related functionalities:

In addition, it also introduces query commands that allow applications to determine video coding related capabilities, and command buffer commands that enable recording video coding operations against a video session.

This extension is to be used in conjunction with other extensions that enable specific video coding operations.

VK_KHR_video_queue
Name String
VK_KHR_video_queue
Extension Type
Device extension
Registered Extension Number
24
Revision
8
Extension and Version Dependencies
Version 1.1 and VK_KHR_synchronization2
Contact
Extension Proposal
VK_KHR_video_queue
Other Extension Metadata
Last Modified Date
2022-09-29
IP Status
No known IP claims.
Contributors
  • Ahmed Abdelkhalek, AMD
  • George Hao, AMD
  • Jake Beju, AMD
  • Piers Daniell, NVIDIA
  • Srinath Kumarapuram, NVIDIA
  • Tobias Hector, AMD
  • Tony Zlatinski, NVIDIA
  • Daniel Rakos, RasterGrid

Field Summary

Modifier and TypeField and Description
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 String
public static final int
VK_KHR_VIDEO_QUEUE_SPEC_VERSION

The extension specification version.

public static final int
VK_OBJECT_TYPE_VIDEO_SESSION_KHR

Extends VkObjectType.

public static final int
public static final int
VK_QUERY_RESULT_STATUS_COMPLETE_KHR

VkQueryResultStatusKHR - Specific status codes for operations Description

public static final int
VK_QUERY_RESULT_STATUS_ERROR_KHR

VkQueryResultStatusKHR - Specific status codes for operations Description

public static final int
VK_QUERY_RESULT_STATUS_NOT_READY_KHR

VkQueryResultStatusKHR - Specific status codes for operations Description

public static final int
VK_QUERY_RESULT_WITH_STATUS_BIT_KHR

Extends VkQueryResultFlagBits.

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
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_CAPABILITY_PROTECTED_CONTENT_BIT_KHR

VkVideoCapabilityFlagBitsKHR - Video decode and encode capability bits Description

public static final int
VK_VIDEO_CAPABILITY_SEPARATE_REFERENCE_IMAGES_BIT_KHR

VkVideoCapabilityFlagBitsKHR - Video decode and encode capability bits Description

public static final int
VK_VIDEO_CHROMA_SUBSAMPLING_420_BIT_KHR

VkVideoChromaSubsamplingFlagBitsKHR - Video format chroma subsampling bits Description

public static final int
VK_VIDEO_CHROMA_SUBSAMPLING_422_BIT_KHR

VkVideoChromaSubsamplingFlagBitsKHR - Video format chroma subsampling bits Description

public static final int
VK_VIDEO_CHROMA_SUBSAMPLING_444_BIT_KHR

VkVideoChromaSubsamplingFlagBitsKHR - Video format chroma subsampling bits Description

public static final int
VK_VIDEO_CHROMA_SUBSAMPLING_INVALID_KHR

VkVideoChromaSubsamplingFlagBitsKHR - Video format chroma subsampling bits Description

public static final int
VK_VIDEO_CHROMA_SUBSAMPLING_MONOCHROME_BIT_KHR

VkVideoChromaSubsamplingFlagBitsKHR - Video format chroma subsampling bits Description

public static final int
VK_VIDEO_CODEC_OPERATION_NONE_KHR

VkVideoCodecOperationFlagBitsKHR - Video codec operation bits Description

public static final int
VK_VIDEO_CODING_CONTROL_RESET_BIT_KHR

VkVideoCodingControlFlagBitsKHR - Video coding control flags Description

public static final int
VK_VIDEO_COMPONENT_BIT_DEPTH_10_BIT_KHR

VkVideoComponentBitDepthFlagBitsKHR - Video format component bit depth Description

public static final int
VK_VIDEO_COMPONENT_BIT_DEPTH_12_BIT_KHR

VkVideoComponentBitDepthFlagBitsKHR - Video format component bit depth Description

public static final int
VK_VIDEO_COMPONENT_BIT_DEPTH_8_BIT_KHR

VkVideoComponentBitDepthFlagBitsKHR - Video format component bit depth Description

public static final int
VK_VIDEO_COMPONENT_BIT_DEPTH_INVALID_KHR

VkVideoComponentBitDepthFlagBitsKHR - Video format component bit depth Description

public static final int
VK_VIDEO_SESSION_CREATE_PROTECTED_CONTENT_BIT_KHR

VkVideoSessionCreateFlagBitsKHR - Video session creation flags Description

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public static int
nvkBindVideoSessionMemoryKHR(VkDevice device, long videoSession, int
the number of elements in pBindSessionMemoryInfos.
bindSessionMemoryInfoCount
,
long pBindSessionMemoryInfos)

Unsafe version of: BindVideoSessionMemoryKHR

public static void
nvkCmdBeginVideoCodingKHR(VkCommandBuffer commandBuffer, long pBeginInfo)

Unsafe version of: CmdBeginVideoCodingKHR

public static void
nvkCmdControlVideoCodingKHR(VkCommandBuffer commandBuffer, long pCodingControlInfo)

Unsafe version of: CmdControlVideoCodingKHR

public static void
nvkCmdEndVideoCodingKHR(VkCommandBuffer commandBuffer, long pEndCodingInfo)

Unsafe version of: CmdEndVideoCodingKHR

public static int
nvkCreateVideoSessionKHR(VkDevice device, long pCreateInfo, long pAllocator, long pVideoSession)

Unsafe version of: CreateVideoSessionKHR

public static int
nvkCreateVideoSessionParametersKHR(VkDevice device, long pCreateInfo, long pAllocator, long pVideoSessionParameters)

Unsafe version of: CreateVideoSessionParametersKHR

public static void
nvkDestroyVideoSessionKHR(VkDevice device, long videoSession, long pAllocator)

Unsafe version of: DestroyVideoSessionKHR

public static void
nvkDestroyVideoSessionParametersKHR(VkDevice device, long videoSessionParameters, long pAllocator)

Unsafe version of: DestroyVideoSessionParametersKHR

public static int
nvkGetPhysicalDeviceVideoCapabilitiesKHR(VkPhysicalDevice physicalDevice, long pVideoProfile, long pCapabilities)

Unsafe version of: GetPhysicalDeviceVideoCapabilitiesKHR

public static int
nvkGetPhysicalDeviceVideoFormatPropertiesKHR(VkPhysicalDevice physicalDevice, long pVideoFormatInfo, long
a pointer to an integer related to the number of video format properties available or queried, as described below.
pVideoFormatPropertyCount
,
long pVideoFormatProperties)

Unsafe version of: GetPhysicalDeviceVideoFormatPropertiesKHR

public static int
nvkGetVideoSessionMemoryRequirementsKHR(VkDevice device, long videoSession, long
a pointer to an integer related to the number of memory binding requirements available or queried, as described below.
pMemoryRequirementsCount
,
long pMemoryRequirements)

Unsafe version of: GetVideoSessionMemoryRequirementsKHR

public static int
nvkUpdateVideoSessionParametersKHR(VkDevice device, long videoSessionParameters, long pUpdateInfo)

Unsafe version of: UpdateVideoSessionParametersKHR

public static int
vkBindVideoSessionMemoryKHR(VkDevice
the logical device that owns the video session.
device
,
long
the video session to be bound with device memory.
videoSession
,
VkBindVideoSessionMemoryInfoKHR.Buffer
a pointer to an array of bindSessionMemoryInfoCount VkBindVideoSessionMemoryInfoKHR structures specifying memory regions to be bound to specific memory bindings of the video session.
pBindSessionMemoryInfos
)

Bind Video Memory.

public static void
vkCmdBeginVideoCodingKHR(VkCommandBuffer
the command buffer in which to record the command.
commandBuffer
,
VkVideoBeginCodingInfoKHR
a pointer to a VkVideoBeginCodingInfoKHR structure specifying the parameters of the video coding scope, including the video session and video session parameters object to use.
pBeginInfo
)

Begin video coding scope.

public static void
vkCmdControlVideoCodingKHR(VkCommandBuffer
the command buffer in which to record the command.
commandBuffer
,
VkVideoCodingControlInfoKHR
a pointer to a VkVideoCodingControlInfoKHR structure specifying the control parameters.
pCodingControlInfo
)

Control video coding parameters.

public static void
vkCmdEndVideoCodingKHR(VkCommandBuffer
the command buffer in which to record the command.
commandBuffer
,
VkVideoEndCodingInfoKHR
a pointer to a VkVideoEndCodingInfoKHR structure specifying the parameters for ending the video coding scope.
pEndCodingInfo
)

End video coding scope.

public static int
vkCreateVideoSessionKHR(VkDevice
the logical device that creates the video session.
device
,
VkVideoSessionCreateInfoKHR
a pointer to a VkVideoSessionCreateInfoKHR structure containing parameters to be used to create the video session.
pCreateInfo
,
VkAllocationCallbacks
controls host memory allocation as described in the Memory Allocation chapter.
pAllocator
,
LongBuffer
a pointer to a VkVideoSessionKHR handle in which the resulting video session object is returned.
pVideoSession
)

Creates a video session object.

public static int
vkCreateVideoSessionKHR(VkDevice device, VkVideoSessionCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, long[] pVideoSession)

Array version of: CreateVideoSessionKHR

public static int
vkCreateVideoSessionParametersKHR(VkDevice
the logical device that creates the video session parameters object.
device
,
VkVideoSessionParametersCreateInfoKHR
a pointer to VkVideoSessionParametersCreateInfoKHR structure containing parameters to be used to create the video session parameters object.
pCreateInfo
,
VkAllocationCallbacks
controls host memory allocation as described in the Memory Allocation chapter.
pAllocator
,
LongBuffer
a pointer to a VkVideoSessionParametersKHR handle in which the resulting video session parameters object is returned.
pVideoSessionParameters
)

Creates video session parameters object.

public static int
vkCreateVideoSessionParametersKHR(VkDevice device, VkVideoSessionParametersCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, long[] pVideoSessionParameters)

Array version of: CreateVideoSessionParametersKHR

public static void
vkDestroyVideoSessionKHR(VkDevice
the logical device that destroys the video session.
device
,
long
the video session to destroy.
videoSession
,
VkAllocationCallbacks
controls host memory allocation as described in the Memory Allocation chapter.
pAllocator
)

Destroy video session object.

public static void
vkDestroyVideoSessionParametersKHR(VkDevice
the logical device that destroys the video session parameters object.
device
,
long
the video session parameters object to destroy.
videoSessionParameters
,
VkAllocationCallbacks
controls host memory allocation as described in the Memory Allocation chapter.
pAllocator
)

Destroy video session parameters object.

public static int
vkGetPhysicalDeviceVideoCapabilitiesKHR(VkPhysicalDevice
the physical device from which to query the video decode or encode capabilities.
physicalDevice
,
VkVideoProfileInfoKHR
a pointer to a VkVideoProfileInfoKHR structure.
pVideoProfile
,
VkVideoCapabilitiesKHR
a pointer to a VkVideoCapabilitiesKHR structure in which the capabilities are returned.
pCapabilities
)

Query video coding capabilities.

public static int
vkGetPhysicalDeviceVideoFormatPropertiesKHR(VkPhysicalDevice
the physical device from which to query the video format properties.
physicalDevice
,
VkPhysicalDeviceVideoFormatInfoKHR
a pointer to a VkPhysicalDeviceVideoFormatInfoKHR structure specifying the usage and video profiles for which supported image formats and capabilities are returned.
pVideoFormatInfo
,
IntBuffer
a pointer to an integer related to the number of video format properties available or queried, as described below.
pVideoFormatPropertyCount
,
VkVideoFormatPropertiesKHR.Buffer
a pointer to an array of VkVideoFormatPropertiesKHR structures in which supported image formats and capabilities are returned.
pVideoFormatProperties
)

Query supported video decode and encode image formats and capabilities.

public static int
vkGetPhysicalDeviceVideoFormatPropertiesKHR(VkPhysicalDevice physicalDevice, VkPhysicalDeviceVideoFormatInfoKHR pVideoFormatInfo, int[] pVideoFormatPropertyCount, VkVideoFormatPropertiesKHR.Buffer pVideoFormatProperties)

Array version of: GetPhysicalDeviceVideoFormatPropertiesKHR

public static int
vkGetVideoSessionMemoryRequirementsKHR(VkDevice
the logical device that owns the video session.
device
,
long
the video session to query.
videoSession
,
IntBuffer
a pointer to an integer related to the number of memory binding requirements available or queried, as described below.
pMemoryRequirementsCount
,
VkVideoSessionMemoryRequirementsKHR.Buffer
NULL or a pointer to an array of VkVideoSessionMemoryRequirementsKHR structures in which the memory binding requirements of the video session are returned.
pMemoryRequirements
)

Get the memory requirements for a video session.

public static int
vkGetVideoSessionMemoryRequirementsKHR(VkDevice device, long videoSession, int[] pMemoryRequirementsCount, VkVideoSessionMemoryRequirementsKHR.Buffer pMemoryRequirements)

Array version of: GetVideoSessionMemoryRequirementsKHR

public static int
vkUpdateVideoSessionParametersKHR(VkDevice
the logical device that updates the video session parameters.
device
,
long
the video session parameters object to update.
videoSessionParameters
,
VkVideoSessionParametersUpdateInfoKHR
a pointer to a VkVideoSessionParametersUpdateInfoKHR structure specifying the parameter update information.
pUpdateInfo
)

Update video session parameters object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait