Package org.lwjgl.vulkan

Class VkVideoEncodeInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeInfoKHR>

org.lwjgl.vulkan.VkVideoEncodeInfoKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkVideoEncodeInfoKHR
extends Struct<VkVideoEncodeInfoKHR>
implements NativeResource

 struct VkVideoEncodeInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkVideoEncodeFlagsKHR flags;
     VkBuffer dstBuffer;
     VkDeviceSize dstBufferOffset;
     VkDeviceSize dstBufferRange;
     {@link VkVideoPictureResourceInfoKHR VkVideoPictureResourceInfoKHR} srcPictureResource;
     {@link VkVideoReferenceSlotInfoKHR VkVideoReferenceSlotInfoKHR} const * pSetupReferenceSlot;
     uint32_t referenceSlotCount;
     {@link VkVideoReferenceSlotInfoKHR VkVideoReferenceSlotInfoKHR} const * pReferenceSlots;
     uint32_t precedingExternallyEncodedBytes;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoEncodeInfoKHR.Buffer	An array of VkVideoEncodeInfoKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DSTBUFFER	The struct member offsets.
static final int	DSTBUFFEROFFSET	The struct member offsets.
static final int	DSTBUFFERRANGE	The struct member offsets.
static final int	FLAGS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PRECEDINGEXTERNALLYENCODEDBYTES	The struct member offsets.
static final int	PREFERENCESLOTS	The struct member offsets.
static final int	PSETUPREFERENCESLOT	The struct member offsets.
static final int	REFERENCESLOTCOUNT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SRCPICTURERESOURCE	The struct member offsets.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkVideoEncodeInfoKHR(ByteBuffer container)	Creates a VkVideoEncodeInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeInfoKHR	calloc()	Returns a new VkVideoEncodeInfoKHR instance allocated with memCalloc.
static VkVideoEncodeInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeInfoKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkVideoEncodeInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeInfoKHR	calloc(MemoryStack stack)	Returns a new VkVideoEncodeInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeInfoKHR	create()	Returns a new VkVideoEncodeInfoKHR instance allocated with BufferUtils.
static VkVideoEncodeInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeInfoKHR	create(long address)	Returns a new VkVideoEncodeInfoKHR instance for the specified memory address.
static VkVideoEncodeInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	dstBuffer()
VkVideoEncodeInfoKHR	dstBuffer(long value)	Sets the specified value to the dstBuffer field.
long	dstBufferOffset()
VkVideoEncodeInfoKHR	dstBufferOffset(long value)	Sets the specified value to the dstBufferOffset field.
long	dstBufferRange()
VkVideoEncodeInfoKHR	dstBufferRange(long value)	Sets the specified value to the dstBufferRange field.
int	flags()
VkVideoEncodeInfoKHR	flags(int value)	Sets the specified value to the flags field.
static VkVideoEncodeInfoKHR	malloc()	Returns a new VkVideoEncodeInfoKHR instance allocated with memAlloc.
static VkVideoEncodeInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeInfoKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkVideoEncodeInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeInfoKHR	malloc(MemoryStack stack)	Returns a new VkVideoEncodeInfoKHR instance allocated on the specified MemoryStack.
static long	ndstBuffer(long struct)	Unsafe version of dstBuffer().
static void	ndstBuffer(long struct, long value)	Unsafe version of dstBuffer.
static long	ndstBufferOffset(long struct)	Unsafe version of dstBufferOffset().
static void	ndstBufferOffset(long struct, long value)	Unsafe version of dstBufferOffset.
static long	ndstBufferRange(long struct)	Unsafe version of dstBufferRange().
static void	ndstBufferRange(long struct, long value)	Unsafe version of dstBufferRange.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nprecedingExternallyEncodedBytes(long struct)	Unsafe version of precedingExternallyEncodedBytes().
static void	nprecedingExternallyEncodedBytes(long struct, int value)	Unsafe version of precedingExternallyEncodedBytes.
static @Nullable VkVideoReferenceSlotInfoKHR.Buffer	npReferenceSlots(long struct)	Unsafe version of pReferenceSlots().
static void	npReferenceSlots(long struct, @Nullable VkVideoReferenceSlotInfoKHR.Buffer value)	Unsafe version of pReferenceSlots.
static @Nullable VkVideoReferenceSlotInfoKHR	npSetupReferenceSlot(long struct)	Unsafe version of pSetupReferenceSlot().
static void	npSetupReferenceSlot(long struct, @Nullable VkVideoReferenceSlotInfoKHR value)	Unsafe version of pSetupReferenceSlot.
static int	nreferenceSlotCount(long struct)	Unsafe version of referenceSlotCount().
static void	nreferenceSlotCount(long struct, int value)	Sets the specified value to the referenceSlotCount field of the specified struct.
static VkVideoPictureResourceInfoKHR	nsrcPictureResource(long struct)	Unsafe version of srcPictureResource().
static void	nsrcPictureResource(long struct, VkVideoPictureResourceInfoKHR value)	Unsafe version of srcPictureResource.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkVideoEncodeInfoKHR	pNext(long value)	Sets the specified value to the pNext field.
VkVideoEncodeInfoKHR	pNext(VkVideoEncodeAV1PictureInfoKHR value)	Prepends the specified VkVideoEncodeAV1PictureInfoKHR value to the pNext chain.
VkVideoEncodeInfoKHR	pNext(VkVideoEncodeH264PictureInfoKHR value)	Prepends the specified VkVideoEncodeH264PictureInfoKHR value to the pNext chain.
VkVideoEncodeInfoKHR	pNext(VkVideoEncodeH265PictureInfoKHR value)	Prepends the specified VkVideoEncodeH265PictureInfoKHR value to the pNext chain.
VkVideoEncodeInfoKHR	pNext(VkVideoEncodeQuantizationMapInfoKHR value)	Prepends the specified VkVideoEncodeQuantizationMapInfoKHR value to the pNext chain.
VkVideoEncodeInfoKHR	pNext(VkVideoInlineQueryInfoKHR value)	Prepends the specified VkVideoInlineQueryInfoKHR value to the pNext chain.
int	precedingExternallyEncodedBytes()
VkVideoEncodeInfoKHR	precedingExternallyEncodedBytes(int value)	Sets the specified value to the precedingExternallyEncodedBytes field.
@Nullable VkVideoReferenceSlotInfoKHR.Buffer	pReferenceSlots()
VkVideoEncodeInfoKHR	pReferenceSlots(@Nullable VkVideoReferenceSlotInfoKHR.Buffer value)	Sets the address of the specified VkVideoReferenceSlotInfoKHR.Buffer to the pReferenceSlots field.
@Nullable VkVideoReferenceSlotInfoKHR	pSetupReferenceSlot()
VkVideoEncodeInfoKHR	pSetupReferenceSlot(@Nullable VkVideoReferenceSlotInfoKHR value)	Sets the address of the specified VkVideoReferenceSlotInfoKHR to the pSetupReferenceSlot field.
int	referenceSlotCount()
VkVideoEncodeInfoKHR	set(int sType, long pNext, int flags, long dstBuffer, long dstBufferOffset, long dstBufferRange, VkVideoPictureResourceInfoKHR srcPictureResource, @Nullable VkVideoReferenceSlotInfoKHR pSetupReferenceSlot, @Nullable VkVideoReferenceSlotInfoKHR.Buffer pReferenceSlots, int precedingExternallyEncodedBytes)	Initializes this struct with the specified values.
VkVideoEncodeInfoKHR	set(VkVideoEncodeInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
VkVideoPictureResourceInfoKHR	srcPictureResource()
VkVideoEncodeInfoKHR	srcPictureResource(Consumer<VkVideoPictureResourceInfoKHR> consumer)	Passes the srcPictureResource field to the specified Consumer.
VkVideoEncodeInfoKHR	srcPictureResource(VkVideoPictureResourceInfoKHR value)	Copies the specified VkVideoPictureResourceInfoKHR to the srcPictureResource field.
int	sType()
VkVideoEncodeInfoKHR	sType(int value)	Sets the specified value to the sType field.
VkVideoEncodeInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_ENCODE_INFO_KHR value to the sType field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

DSTBUFFER

public static final int DSTBUFFER

The struct member offsets.

DSTBUFFEROFFSET

public static final int DSTBUFFEROFFSET

The struct member offsets.

DSTBUFFERRANGE

public static final int DSTBUFFERRANGE

The struct member offsets.

SRCPICTURERESOURCE

public static final int SRCPICTURERESOURCE

The struct member offsets.

PSETUPREFERENCESLOT

public static final int PSETUPREFERENCESLOT

The struct member offsets.

REFERENCESLOTCOUNT

public static final int REFERENCESLOTCOUNT

The struct member offsets.

PREFERENCESLOTS

public static final int PREFERENCESLOTS

The struct member offsets.

PRECEDINGEXTERNALLYENCODEDBYTES

public static final int PRECEDINGEXTERNALLYENCODEDBYTES

The struct member offsets.

Constructor Details

VkVideoEncodeInfoKHR

public VkVideoEncodeInfoKHR(ByteBuffer container)

Creates a VkVideoEncodeInfoKHR instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkVideoEncodeInfoKHR>

sType

public int sType()

Returns:

the value of the sType field.

pNext

public long pNext()

Returns:

the value of the pNext field.

flags

public int flags()

Returns:

the value of the flags field.

dstBuffer

public long dstBuffer()

Returns:

the value of the dstBuffer field.

dstBufferOffset

public long dstBufferOffset()

Returns:

the value of the dstBufferOffset field.

dstBufferRange

public long dstBufferRange()

Returns:

the value of the dstBufferRange field.

srcPictureResource

public VkVideoPictureResourceInfoKHR srcPictureResource()

Returns:

a VkVideoPictureResourceInfoKHR view of the srcPictureResource field.

pSetupReferenceSlot

public @Nullable VkVideoReferenceSlotInfoKHR pSetupReferenceSlot()

Returns:

a VkVideoReferenceSlotInfoKHR view of the struct pointed to by the pSetupReferenceSlot field.

referenceSlotCount

public int referenceSlotCount()

Returns:

the value of the referenceSlotCount field.

pReferenceSlots

public @Nullable VkVideoReferenceSlotInfoKHR.Buffer pReferenceSlots()

Returns:

a VkVideoReferenceSlotInfoKHR.Buffer view of the struct array pointed to by the pReferenceSlots field.

precedingExternallyEncodedBytes

public int precedingExternallyEncodedBytes()

Returns:

the value of the precedingExternallyEncodedBytes field.

sType

public VkVideoEncodeInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkVideoEncodeInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_INFO_KHR value to the sType field.

pNext

public VkVideoEncodeInfoKHR pNext(long value)

Sets the specified value to the pNext field.

pNext

public VkVideoEncodeInfoKHR pNext(VkVideoEncodeAV1PictureInfoKHR value)

Prepends the specified VkVideoEncodeAV1PictureInfoKHR value to the pNext chain.

pNext

public VkVideoEncodeInfoKHR pNext(VkVideoEncodeH264PictureInfoKHR value)

Prepends the specified VkVideoEncodeH264PictureInfoKHR value to the pNext chain.

pNext

public VkVideoEncodeInfoKHR pNext(VkVideoEncodeH265PictureInfoKHR value)

Prepends the specified VkVideoEncodeH265PictureInfoKHR value to the pNext chain.

pNext

public VkVideoEncodeInfoKHR pNext(VkVideoEncodeQuantizationMapInfoKHR value)

Prepends the specified VkVideoEncodeQuantizationMapInfoKHR value to the pNext chain.

pNext

public VkVideoEncodeInfoKHR pNext(VkVideoInlineQueryInfoKHR value)

Prepends the specified VkVideoInlineQueryInfoKHR value to the pNext chain.

flags

public VkVideoEncodeInfoKHR flags(int value)

Sets the specified value to the flags field.

dstBuffer

public VkVideoEncodeInfoKHR dstBuffer(long value)

Sets the specified value to the dstBuffer field.

dstBufferOffset

public VkVideoEncodeInfoKHR dstBufferOffset(long value)

Sets the specified value to the dstBufferOffset field.

dstBufferRange

public VkVideoEncodeInfoKHR dstBufferRange(long value)

Sets the specified value to the dstBufferRange field.

srcPictureResource

public VkVideoEncodeInfoKHR srcPictureResource(VkVideoPictureResourceInfoKHR value)

Copies the specified VkVideoPictureResourceInfoKHR to the srcPictureResource field.

srcPictureResource

public VkVideoEncodeInfoKHR srcPictureResource(Consumer<VkVideoPictureResourceInfoKHR> consumer)

Passes the srcPictureResource field to the specified Consumer.

pSetupReferenceSlot

public VkVideoEncodeInfoKHR pSetupReferenceSlot(@Nullable VkVideoReferenceSlotInfoKHR value)

Sets the address of the specified VkVideoReferenceSlotInfoKHR to the pSetupReferenceSlot field.

pReferenceSlots

public VkVideoEncodeInfoKHR pReferenceSlots(@Nullable VkVideoReferenceSlotInfoKHR.Buffer value)

Sets the address of the specified VkVideoReferenceSlotInfoKHR.Buffer to the pReferenceSlots field.

precedingExternallyEncodedBytes

public VkVideoEncodeInfoKHR precedingExternallyEncodedBytes(int value)

Sets the specified value to the precedingExternallyEncodedBytes field.

set

public VkVideoEncodeInfoKHR set(int sType,
 long pNext,
 int flags,
 long dstBuffer,
 long dstBufferOffset,
 long dstBufferRange,
 VkVideoPictureResourceInfoKHR srcPictureResource,
 @Nullable VkVideoReferenceSlotInfoKHR pSetupReferenceSlot,
 @Nullable VkVideoReferenceSlotInfoKHR.Buffer pReferenceSlots,
 int precedingExternallyEncodedBytes)

Initializes this struct with the specified values.

set

public VkVideoEncodeInfoKHR set(VkVideoEncodeInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeInfoKHR malloc()

Returns a new VkVideoEncodeInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkVideoEncodeInfoKHR calloc()

Returns a new VkVideoEncodeInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkVideoEncodeInfoKHR create()

Returns a new VkVideoEncodeInfoKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeInfoKHR create(long address)

Returns a new VkVideoEncodeInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeInfoKHR.Buffer malloc(int capacity)

Returns a new VkVideoEncodeInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeInfoKHR.Buffer calloc(int capacity)

Returns a new VkVideoEncodeInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeInfoKHR.Buffer create(long address,
 int capacity)

Create a VkVideoEncodeInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkVideoEncodeInfoKHR.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeInfoKHR malloc(MemoryStack stack)

Returns a new VkVideoEncodeInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkVideoEncodeInfoKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkVideoEncodeInfoKHR.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkVideoEncodeInfoKHR.Buffer calloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nflags

public static int nflags(long struct)

Unsafe version of flags().

ndstBuffer

public static long ndstBuffer(long struct)

Unsafe version of dstBuffer().

ndstBufferOffset

public static long ndstBufferOffset(long struct)

Unsafe version of dstBufferOffset().

ndstBufferRange

public static long ndstBufferRange(long struct)

Unsafe version of dstBufferRange().

nsrcPictureResource

public static VkVideoPictureResourceInfoKHR nsrcPictureResource(long struct)

Unsafe version of srcPictureResource().

npSetupReferenceSlot

public static @Nullable VkVideoReferenceSlotInfoKHR npSetupReferenceSlot(long struct)

Unsafe version of pSetupReferenceSlot().

nreferenceSlotCount

public static int nreferenceSlotCount(long struct)

Unsafe version of referenceSlotCount().

npReferenceSlots

public static @Nullable VkVideoReferenceSlotInfoKHR.Buffer npReferenceSlots(long struct)

Unsafe version of pReferenceSlots().

nprecedingExternallyEncodedBytes

public static int nprecedingExternallyEncodedBytes(long struct)

Unsafe version of precedingExternallyEncodedBytes().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

ndstBuffer

public static void ndstBuffer(long struct,
 long value)

Unsafe version of dstBuffer.

ndstBufferOffset

public static void ndstBufferOffset(long struct,
 long value)

Unsafe version of dstBufferOffset.

ndstBufferRange

public static void ndstBufferRange(long struct,
 long value)

Unsafe version of dstBufferRange.

nsrcPictureResource

public static void nsrcPictureResource(long struct,
 VkVideoPictureResourceInfoKHR value)

Unsafe version of srcPictureResource.

npSetupReferenceSlot

public static void npSetupReferenceSlot(long struct,
 @Nullable VkVideoReferenceSlotInfoKHR value)

Unsafe version of pSetupReferenceSlot.

nreferenceSlotCount

public static void nreferenceSlotCount(long struct,
 int value)

Sets the specified value to the referenceSlotCount field of the specified struct.

npReferenceSlots

public static void npReferenceSlots(long struct,
 @Nullable VkVideoReferenceSlotInfoKHR.Buffer value)

Unsafe version of pReferenceSlots.

nprecedingExternallyEncodedBytes

public static void nprecedingExternallyEncodedBytes(long struct,
 int value)

Unsafe version of precedingExternallyEncodedBytes.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate