Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoSessionCreateInfoKHR

extends Struct<VkVideoSessionCreateInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying parameters of a newly created video session.
Valid Usage
Valid Usage (Implicit)
See Also

VkExtensionProperties, VkExtent2D, VkVideoProfileInfoKHR, CreateVideoSessionKHR

Layout


struct VkVideoSessionCreateInfoKHR {
    VkStructureType sType;
    void const * pNext;
    uint32_t queueFamilyIndex;
    VkVideoSessionCreateFlagsKHR flags;
    VkVideoProfileInfoKHR const * pVideoProfile;
    VkFormat pictureFormat;
    VkExtent2D maxCodedExtent;
    VkFormat referencePictureFormat;
    uint32_t maxDpbSlots;
    uint32_t maxActiveReferencePictures;
    VkExtensionProperties const * pStdHeaderVersion;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FLAGS

The struct member offsets.

public static final int
MAXACTIVEREFERENCEPICTURES

The struct member offsets.

public static final int
MAXCODEDEXTENT

The struct member offsets.

public static final int
MAXDPBSLOTS

The struct member offsets.

public static final int
PICTUREFORMAT

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PSTDHEADERVERSION

The struct member offsets.

public static final int
PVIDEOPROFILE

The struct member offsets.

public static final int
QUEUEFAMILYINDEX

The struct member offsets.

public static final int
REFERENCEPICTUREFORMAT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkVideoSessionCreateInfoKHR(long address, ByteBuffer container)

public
VkVideoSessionCreateInfoKHR(ByteBuffer container)

Creates a VkVideoSessionCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkVideoSessionCreateInfoKHR
calloc()

Returns a new VkVideoSessionCreateInfoKHR instance allocated with memCalloc.

public static VkVideoSessionCreateInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkVideoSessionCreateInfoKHR.Buffer instance allocated with memCalloc.

public static VkVideoSessionCreateInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkVideoSessionCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkVideoSessionCreateInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkVideoSessionCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected VkVideoSessionCreateInfoKHR
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkVideoSessionCreateInfoKHR
create()

Returns a new VkVideoSessionCreateInfoKHR instance allocated with BufferUtils.

public static VkVideoSessionCreateInfoKHR
create(long address)

Returns a new VkVideoSessionCreateInfoKHR instance for the specified memory address.

public static VkVideoSessionCreateInfoKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkVideoSessionCreateInfoKHR.Buffer instance allocated with BufferUtils.

public static VkVideoSessionCreateInfoKHR.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkVideoSessionCreateInfoKHR.Buffer instance at the specified memory.

public static VkVideoSessionCreateInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkVideoSessionCreateInfoKHR.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
flags()

a bitmask of VkVideoSessionCreateFlagBitsKHR specifying creation flags.

public VkVideoSessionCreateInfoKHR
flags(int value)

Sets the specified value to the flags field.

public static VkVideoSessionCreateInfoKHR
malloc()

Returns a new VkVideoSessionCreateInfoKHR instance allocated with memAlloc.

public static VkVideoSessionCreateInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkVideoSessionCreateInfoKHR.Buffer instance allocated with memAlloc.

public static VkVideoSessionCreateInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkVideoSessionCreateInfoKHR instance allocated on the specified MemoryStack.

public static VkVideoSessionCreateInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkVideoSessionCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.

public int
maxActiveReferencePictures()

the maximum number of active reference pictures that can be used in a single video coding operation using the created video session.

public VkVideoSessionCreateInfoKHR
maxActiveReferencePictures(int value)

Sets the specified value to the maxActiveReferencePictures field.

public VkExtent2D
maxCodedExtent()

the maximum width and height of the coded frames the created video session will be used with.

public VkVideoSessionCreateInfoKHR
maxCodedExtent(VkExtent2D value)

Copies the specified VkExtent2D to the maxCodedExtent field.

public VkVideoSessionCreateInfoKHR
maxCodedExtent(Consumer<VkExtent2D> consumer)

Passes the maxCodedExtent field to the specified Consumer.

public int
maxDpbSlots()

the maximum number of DPB Slots that can be used with the created video session.

public VkVideoSessionCreateInfoKHR
maxDpbSlots(int value)

Sets the specified value to the maxDpbSlots field.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static int
public static void
nmaxActiveReferencePictures(long struct, int value)

Unsafe version of maxActiveReferencePictures.

public static VkExtent2D
nmaxCodedExtent(long struct)

Unsafe version of maxCodedExtent.

public static void
nmaxCodedExtent(long struct, VkExtent2D value)

Unsafe version of maxCodedExtent.

public static int
nmaxDpbSlots(long struct)

Unsafe version of maxDpbSlots.

public static void
nmaxDpbSlots(long struct, int value)

Unsafe version of maxDpbSlots.

public static int
npictureFormat(long struct)

Unsafe version of pictureFormat.

public static void
npictureFormat(long struct, int value)

Unsafe version of pictureFormat.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkExtensionProperties
npStdHeaderVersion(long struct)

Unsafe version of pStdHeaderVersion.

public static void
npStdHeaderVersion(long struct, VkExtensionProperties value)

Unsafe version of pStdHeaderVersion.

public static VkVideoProfileInfoKHR
npVideoProfile(long struct)

Unsafe version of pVideoProfile.

public static void
npVideoProfile(long struct, VkVideoProfileInfoKHR value)

Unsafe version of pVideoProfile.

public static int
nqueueFamilyIndex(long struct)

Unsafe version of queueFamilyIndex.

public static void
nqueueFamilyIndex(long struct, int value)

Unsafe version of queueFamilyIndex.

public static int
nreferencePictureFormat(long struct)

Unsafe version of referencePictureFormat.

public static void
nreferencePictureFormat(long struct, int value)

Unsafe version of referencePictureFormat.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public int
pictureFormat()

the image format the created video session will be used with.

public VkVideoSessionCreateInfoKHR
pictureFormat(int value)

Sets the specified value to the pictureFormat field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkVideoSessionCreateInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkVideoSessionCreateInfoKHR
pNext(VkVideoEncodeH264SessionCreateInfoEXT value)

Prepends the specified VkVideoEncodeH264SessionCreateInfoEXT value to the pNext chain.

public VkVideoSessionCreateInfoKHR
pNext(VkVideoEncodeH265SessionCreateInfoEXT value)

Prepends the specified VkVideoEncodeH265SessionCreateInfoEXT value to the pNext chain.

public VkExtensionProperties
pStdHeaderVersion()

a pointer to a VkExtensionProperties structure requesting the Video Std header version to use for the videoCodecOperation specified in pVideoProfile.

public VkVideoSessionCreateInfoKHR
pStdHeaderVersion(VkExtensionProperties value)

Sets the address of the specified VkExtensionProperties to the pStdHeaderVersion field.

public VkVideoProfileInfoKHR
pVideoProfile()

a pointer to a VkVideoProfileInfoKHR structure specifying the video profile the created video session will be used with.

public VkVideoSessionCreateInfoKHR
pVideoProfile(VkVideoProfileInfoKHR value)

Sets the address of the specified VkVideoProfileInfoKHR to the pVideoProfile field.

public int
queueFamilyIndex()

the index of the queue family the created video session will be used with.

public VkVideoSessionCreateInfoKHR
queueFamilyIndex(int value)

Sets the specified value to the queueFamilyIndex field.

public int
referencePictureFormat()

the image format of reference pictures stored in the DPB the created video session will be used with.

public VkVideoSessionCreateInfoKHR
referencePictureFormat(int value)

Sets the specified value to the referencePictureFormat field.

public VkVideoSessionCreateInfoKHR
set(int sType, long pNext, int queueFamilyIndex, int flags, VkVideoProfileInfoKHR pVideoProfile, int pictureFormat, VkExtent2D maxCodedExtent, int referencePictureFormat, int maxDpbSlots, int maxActiveReferencePictures, VkExtensionProperties pStdHeaderVersion)

Initializes this struct with the specified values.

public VkVideoSessionCreateInfoKHR

Returns:

this struct
set
(VkVideoSessionCreateInfoKHR
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkVideoSessionCreateInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkVideoSessionCreateInfoKHR
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate