Package org.lwjgl.vulkan

Class VkVideoEncodeH264SessionCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeH264SessionCreateInfoKHR>

org.lwjgl.vulkan.VkVideoEncodeH264SessionCreateInfoKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkVideoEncodeH264SessionCreateInfoKHR
extends org.lwjgl.system.Struct<VkVideoEncodeH264SessionCreateInfoKHR>
implements org.lwjgl.system.NativeResource

Structure specifies H.264 encode session parameters.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_KHR

Layout

 struct VkVideoEncodeH264SessionCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkBool32 useMaxLevelIdc();
     StdVideoH264LevelIdc maxLevelIdc();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	MAXLEVELIDC	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	USEMAXLEVELIDC	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
VkVideoEncodeH264SessionCreateInfoKHR(ByteBuffer container)	Creates a VkVideoEncodeH264SessionCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeH264SessionCreateInfoKHR	calloc()	Returns a new VkVideoEncodeH264SessionCreateInfoKHR instance allocated with memCalloc.
static VkVideoEncodeH264SessionCreateInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeH264SessionCreateInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeH264SessionCreateInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeH264SessionCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeH264SessionCreateInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeH264SessionCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeH264SessionCreateInfoKHR	create()	Returns a new VkVideoEncodeH264SessionCreateInfoKHR instance allocated with BufferUtils.
static VkVideoEncodeH264SessionCreateInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeH264SessionCreateInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeH264SessionCreateInfoKHR	create(long address)	Returns a new VkVideoEncodeH264SessionCreateInfoKHR instance for the specified memory address.
static VkVideoEncodeH264SessionCreateInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeH264SessionCreateInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeH264SessionCreateInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeH264SessionCreateInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoEncodeH264SessionCreateInfoKHR	malloc()	Returns a new VkVideoEncodeH264SessionCreateInfoKHR instance allocated with memAlloc.
static VkVideoEncodeH264SessionCreateInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeH264SessionCreateInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeH264SessionCreateInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeH264SessionCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeH264SessionCreateInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeH264SessionCreateInfoKHR instance allocated on the specified MemoryStack.
int	maxLevelIdc()	a StdVideoH264LevelIdc value specifying the upper bound on the H.264 level for the video bitstreams produced by the created video session, where enum constant STD_VIDEO_H264_LEVEL_IDC_<major>_<minor> identifies H.264 level <major>.<minor> as defined in section A.3 of the ITU-T H.264 Specification.
VkVideoEncodeH264SessionCreateInfoKHR	maxLevelIdc(int value)	Sets the specified value to the maxLevelIdc() field.
static int	nmaxLevelIdc(long struct)	Unsafe version of maxLevelIdc().
static void	nmaxLevelIdc(long struct, int value)	Unsafe version of maxLevelIdc.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nuseMaxLevelIdc(long struct)	Unsafe version of useMaxLevelIdc().
static void	nuseMaxLevelIdc(long struct, int value)	Unsafe version of useMaxLevelIdc.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVideoEncodeH264SessionCreateInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkVideoEncodeH264SessionCreateInfoKHR	set(int sType, long pNext, boolean useMaxLevelIdc, int maxLevelIdc)	Initializes this struct with the specified values.
VkVideoEncodeH264SessionCreateInfoKHR	set(VkVideoEncodeH264SessionCreateInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoEncodeH264SessionCreateInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoEncodeH264SessionCreateInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_KHR value to the sType() field.
boolean	useMaxLevelIdc()	indicates whether the value of maxLevelIdc should be used by the implementation.
VkVideoEncodeH264SessionCreateInfoKHR	useMaxLevelIdc(boolean value)	Sets the specified value to the useMaxLevelIdc() field.

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.

USEMAXLEVELIDC

public static final int USEMAXLEVELIDC

The struct member offsets.

MAXLEVELIDC

public static final int MAXLEVELIDC

The struct member offsets.

Constructor Details

VkVideoEncodeH264SessionCreateInfoKHR

public VkVideoEncodeH264SessionCreateInfoKHR(ByteBuffer container)

Creates a VkVideoEncodeH264SessionCreateInfoKHR 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkVideoEncodeH264SessionCreateInfoKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

useMaxLevelIdc

public boolean useMaxLevelIdc()

indicates whether the value of maxLevelIdc should be used by the implementation. When it is FALSE, the implementation ignores the value of maxLevelIdc and uses the value of VkVideoEncodeH264CapabilitiesKHR::maxLevelIdc, as reported by GetPhysicalDeviceVideoCapabilitiesKHR for the video profile.

maxLevelIdc

public int maxLevelIdc()

a StdVideoH264LevelIdc value specifying the upper bound on the H.264 level for the video bitstreams produced by the created video session, where enum constant STD_VIDEO_H264_LEVEL_IDC_<major>_<minor> identifies H.264 level <major>.<minor> as defined in section A.3 of the ITU-T H.264 Specification.

sType

public VkVideoEncodeH264SessionCreateInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoEncodeH264SessionCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_KHR value to the sType() field.

pNext

public VkVideoEncodeH264SessionCreateInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

useMaxLevelIdc

public VkVideoEncodeH264SessionCreateInfoKHR useMaxLevelIdc(boolean value)

Sets the specified value to the useMaxLevelIdc() field.

maxLevelIdc

public VkVideoEncodeH264SessionCreateInfoKHR maxLevelIdc(int value)

Sets the specified value to the maxLevelIdc() field.

set

public VkVideoEncodeH264SessionCreateInfoKHR set(int sType,
 long pNext,
 boolean useMaxLevelIdc,
 int maxLevelIdc)

Initializes this struct with the specified values.

set

public VkVideoEncodeH264SessionCreateInfoKHR set(VkVideoEncodeH264SessionCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeH264SessionCreateInfoKHR malloc()

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

calloc

public static VkVideoEncodeH264SessionCreateInfoKHR calloc()

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

create

public static VkVideoEncodeH264SessionCreateInfoKHR create()

Returns a new VkVideoEncodeH264SessionCreateInfoKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeH264SessionCreateInfoKHR create(long address)

Returns a new VkVideoEncodeH264SessionCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeH264SessionCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeH264SessionCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeH264SessionCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeH264SessionCreateInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeH264SessionCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeH264SessionCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeH264SessionCreateInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkVideoEncodeH264SessionCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkVideoEncodeH264SessionCreateInfoKHR calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkVideoEncodeH264SessionCreateInfoKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkVideoEncodeH264SessionCreateInfoKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nuseMaxLevelIdc

public static int nuseMaxLevelIdc(long struct)

Unsafe version of useMaxLevelIdc().

nmaxLevelIdc

public static int nmaxLevelIdc(long struct)

Unsafe version of maxLevelIdc().

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.

nuseMaxLevelIdc

public static void nuseMaxLevelIdc(long struct,
 int value)

Unsafe version of useMaxLevelIdc.

nmaxLevelIdc

public static void nmaxLevelIdc(long struct,
 int value)

Unsafe version of maxLevelIdc.