Class VkVideoBeginCodingInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoBeginCodingInfoKHR>

org.lwjgl.vulkan.VkVideoBeginCodingInfoKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkVideoBeginCodingInfoKHR
extends Struct<VkVideoBeginCodingInfoKHR>
implements NativeResource

struct VkVideoBeginCodingInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkVideoBeginCodingFlagsKHR flags;
    VkVideoSessionKHR videoSession;
    VkVideoSessionParametersKHR videoSessionParameters;
    uint32_t referenceSlotCount;
    VkVideoReferenceSlotInfoKHR const * pReferenceSlots;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PREFERENCESLOTS	The struct member offsets.
static final int	REFERENCESLOTCOUNT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	VIDEOSESSION	The struct member offsets.
static final int	VIDEOSESSIONPARAMETERS	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkVideoBeginCodingInfoKHR	calloc()	Returns a new VkVideoBeginCodingInfoKHR instance allocated with memCalloc.
static VkVideoBeginCodingInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoBeginCodingInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoBeginCodingInfoKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkVideoBeginCodingInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoBeginCodingInfoKHR	calloc(MemoryStack stack)	Returns a new VkVideoBeginCodingInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoBeginCodingInfoKHR	create()	Returns a new VkVideoBeginCodingInfoKHR instance allocated with BufferUtils.
static VkVideoBeginCodingInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoBeginCodingInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoBeginCodingInfoKHR	create(long address)	Returns a new VkVideoBeginCodingInfoKHR instance for the specified memory address.
static VkVideoBeginCodingInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoBeginCodingInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoBeginCodingInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoBeginCodingInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()
VkVideoBeginCodingInfoKHR	flags(int value)	Sets the specified value to the flags field.
static VkVideoBeginCodingInfoKHR	malloc()	Returns a new VkVideoBeginCodingInfoKHR instance allocated with memAlloc.
static VkVideoBeginCodingInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoBeginCodingInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoBeginCodingInfoKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkVideoBeginCodingInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoBeginCodingInfoKHR	malloc(MemoryStack stack)	Returns a new VkVideoBeginCodingInfoKHR instance allocated on the specified MemoryStack.
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 @Nullable VkVideoReferenceSlotInfoKHR.Buffer	npReferenceSlots(long struct)	Unsafe version of pReferenceSlots().
static void	npReferenceSlots(long struct, @Nullable VkVideoReferenceSlotInfoKHR.Buffer value)	Unsafe version of pReferenceSlots.
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 int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static long	nvideoSession(long struct)	Unsafe version of videoSession().
static void	nvideoSession(long struct, long value)	Unsafe version of videoSession.
static long	nvideoSessionParameters(long struct)	Unsafe version of videoSessionParameters().
static void	nvideoSessionParameters(long struct, long value)	Unsafe version of videoSessionParameters.
long	pNext()
VkVideoBeginCodingInfoKHR	pNext(long value)	Sets the specified value to the pNext field.
VkVideoBeginCodingInfoKHR	pNext(VkVideoEncodeAV1GopRemainingFrameInfoKHR value)	Prepends the specified VkVideoEncodeAV1GopRemainingFrameInfoKHR value to the pNext chain.
VkVideoBeginCodingInfoKHR	pNext(VkVideoEncodeAV1RateControlInfoKHR value)	Prepends the specified VkVideoEncodeAV1RateControlInfoKHR value to the pNext chain.
VkVideoBeginCodingInfoKHR	pNext(VkVideoEncodeH264GopRemainingFrameInfoKHR value)	Prepends the specified VkVideoEncodeH264GopRemainingFrameInfoKHR value to the pNext chain.
VkVideoBeginCodingInfoKHR	pNext(VkVideoEncodeH264RateControlInfoKHR value)	Prepends the specified VkVideoEncodeH264RateControlInfoKHR value to the pNext chain.
VkVideoBeginCodingInfoKHR	pNext(VkVideoEncodeH265GopRemainingFrameInfoKHR value)	Prepends the specified VkVideoEncodeH265GopRemainingFrameInfoKHR value to the pNext chain.
VkVideoBeginCodingInfoKHR	pNext(VkVideoEncodeH265RateControlInfoKHR value)	Prepends the specified VkVideoEncodeH265RateControlInfoKHR value to the pNext chain.
VkVideoBeginCodingInfoKHR	pNext(VkVideoEncodeRateControlInfoKHR value)	Prepends the specified VkVideoEncodeRateControlInfoKHR value to the pNext chain.
@Nullable VkVideoReferenceSlotInfoKHR.Buffer	pReferenceSlots()
VkVideoBeginCodingInfoKHR	pReferenceSlots(@Nullable VkVideoReferenceSlotInfoKHR.Buffer value)	Sets the address of the specified VkVideoReferenceSlotInfoKHR.Buffer to the pReferenceSlots field.
int	referenceSlotCount()
VkVideoBeginCodingInfoKHR	set(int sType, long pNext, int flags, long videoSession, long videoSessionParameters, @Nullable VkVideoReferenceSlotInfoKHR.Buffer pReferenceSlots)	Initializes this struct with the specified values.
VkVideoBeginCodingInfoKHR	set(VkVideoBeginCodingInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkVideoBeginCodingInfoKHR	sType(int value)	Sets the specified value to the sType field.
VkVideoBeginCodingInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_BEGIN_CODING_INFO_KHR value to the sType field.
static void	validate(long struct)	Validates pointer members that should not be NULL.
long	videoSession()
VkVideoBeginCodingInfoKHR	videoSession(long value)	Sets the specified value to the videoSession field.
long	videoSessionParameters()
VkVideoBeginCodingInfoKHR	videoSessionParameters(long value)	Sets the specified value to the videoSessionParameters field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

VIDEOSESSION

public static final int VIDEOSESSION

The struct member offsets.

VIDEOSESSIONPARAMETERS

public static final int VIDEOSESSIONPARAMETERS

The struct member offsets.

REFERENCESLOTCOUNT

public static final int REFERENCESLOTCOUNT

The struct member offsets.

PREFERENCESLOTS

public static final int PREFERENCESLOTS

The struct member offsets.

Constructor Details

VkVideoBeginCodingInfoKHR

public VkVideoBeginCodingInfoKHR(ByteBuffer container)

Creates a VkVideoBeginCodingInfoKHR 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<VkVideoBeginCodingInfoKHR>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

flags

@NativeType("VkVideoBeginCodingFlagsKHR")
public int flags()

Returns:

the value of the flags field.

videoSession

@NativeType("VkVideoSessionKHR")
public long videoSession()

Returns:

the value of the videoSession field.

videoSessionParameters

@NativeType("VkVideoSessionParametersKHR")
public long videoSessionParameters()

Returns:

the value of the videoSessionParameters field.

referenceSlotCount

@NativeType("uint32_t")
public int referenceSlotCount()

Returns:

the value of the referenceSlotCount field.

pReferenceSlots

@NativeType("VkVideoReferenceSlotInfoKHR const *")
public @Nullable VkVideoReferenceSlotInfoKHR.Buffer pReferenceSlots()

Returns:

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

sType

public VkVideoBeginCodingInfoKHR sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkVideoBeginCodingInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_BEGIN_CODING_INFO_KHR value to the sType field.

pNext

public VkVideoBeginCodingInfoKHR pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

pNext

public VkVideoBeginCodingInfoKHR pNext(VkVideoEncodeAV1GopRemainingFrameInfoKHR value)

Prepends the specified VkVideoEncodeAV1GopRemainingFrameInfoKHR value to the pNext chain.

pNext

public VkVideoBeginCodingInfoKHR pNext(VkVideoEncodeAV1RateControlInfoKHR value)

Prepends the specified VkVideoEncodeAV1RateControlInfoKHR value to the pNext chain.

pNext

public VkVideoBeginCodingInfoKHR pNext(VkVideoEncodeH264GopRemainingFrameInfoKHR value)

Prepends the specified VkVideoEncodeH264GopRemainingFrameInfoKHR value to the pNext chain.

pNext

public VkVideoBeginCodingInfoKHR pNext(VkVideoEncodeH264RateControlInfoKHR value)

Prepends the specified VkVideoEncodeH264RateControlInfoKHR value to the pNext chain.

pNext

public VkVideoBeginCodingInfoKHR pNext(VkVideoEncodeH265GopRemainingFrameInfoKHR value)

Prepends the specified VkVideoEncodeH265GopRemainingFrameInfoKHR value to the pNext chain.

pNext

public VkVideoBeginCodingInfoKHR pNext(VkVideoEncodeH265RateControlInfoKHR value)

Prepends the specified VkVideoEncodeH265RateControlInfoKHR value to the pNext chain.

pNext

public VkVideoBeginCodingInfoKHR pNext(VkVideoEncodeRateControlInfoKHR value)

Prepends the specified VkVideoEncodeRateControlInfoKHR value to the pNext chain.

flags

public VkVideoBeginCodingInfoKHR flags(@NativeType("VkVideoBeginCodingFlagsKHR")
 int value)

Sets the specified value to the flags field.

videoSession

public VkVideoBeginCodingInfoKHR videoSession(@NativeType("VkVideoSessionKHR")
 long value)

Sets the specified value to the videoSession field.

videoSessionParameters

public VkVideoBeginCodingInfoKHR videoSessionParameters(@NativeType("VkVideoSessionParametersKHR")
 long value)

Sets the specified value to the videoSessionParameters field.

pReferenceSlots

public VkVideoBeginCodingInfoKHR pReferenceSlots(@NativeType("VkVideoReferenceSlotInfoKHR const *")
 @Nullable VkVideoReferenceSlotInfoKHR.Buffer value)

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

set

public VkVideoBeginCodingInfoKHR set(int sType,
 long pNext,
 int flags,
 long videoSession,
 long videoSessionParameters,
 @Nullable VkVideoReferenceSlotInfoKHR.Buffer pReferenceSlots)

Initializes this struct with the specified values.

set

public VkVideoBeginCodingInfoKHR set(VkVideoBeginCodingInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoBeginCodingInfoKHR malloc()

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

calloc

public static VkVideoBeginCodingInfoKHR calloc()

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

create

public static VkVideoBeginCodingInfoKHR create()

Returns a new VkVideoBeginCodingInfoKHR instance allocated with BufferUtils.

create

public static VkVideoBeginCodingInfoKHR create(long address)

Returns a new VkVideoBeginCodingInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoBeginCodingInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoBeginCodingInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoBeginCodingInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoBeginCodingInfoKHR.Buffer create(int capacity)

Returns a new VkVideoBeginCodingInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoBeginCodingInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkVideoBeginCodingInfoKHR malloc(MemoryStack stack)

Returns a new VkVideoBeginCodingInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkVideoBeginCodingInfoKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkVideoBeginCodingInfoKHR.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().

nvideoSession

public static long nvideoSession(long struct)

Unsafe version of videoSession().

nvideoSessionParameters

public static long nvideoSessionParameters(long struct)

Unsafe version of videoSessionParameters().

nreferenceSlotCount

public static int nreferenceSlotCount(long struct)

Unsafe version of referenceSlotCount().

npReferenceSlots

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

Unsafe version of pReferenceSlots().

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.

nvideoSession

public static void nvideoSession(long struct,
 long value)

Unsafe version of videoSession.

nvideoSessionParameters

public static void nvideoSessionParameters(long struct,
 long value)

Unsafe version of videoSessionParameters.

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.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate