Package org.lwjgl.vulkan

Class VkVideoProfileListInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoProfileListInfoKHR>

org.lwjgl.vulkan.VkVideoProfileListInfoKHR

All Implemented Interfaces:

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

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

Structure specifying one or more video profiles used in conjunction.

Description

Note

Video transcoding is an example of a use case that necessitates the specification of multiple profiles in various contexts.

When the application provides a video decode profile and one or more video encode profiles in the profile list, the implementation ensures that any capabilitities returned or resources created are suitable for the video transcoding use cases without the need for manual data transformations.

Valid Usage

• pProfiles must not contain more than one element whose videoCodecOperation member specifies a decode operation

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_PROFILE_LIST_INFO_KHR
• If profileCount is not 0, pProfiles must be a valid pointer to an array of profileCount valid VkVideoProfileInfoKHR structures

See Also

VkVideoProfileInfoKHR

Layout

 struct VkVideoProfileListInfoKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t profileCount();
     VkVideoProfileInfoKHR const * pProfiles();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoProfileListInfoKHR.Buffer	An array of VkVideoProfileListInfoKHR 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	PNEXT	The struct member offsets.
static final int	PPROFILES	The struct member offsets.
static final int	PROFILECOUNT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
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
VkVideoProfileListInfoKHR(ByteBuffer container)	Creates a VkVideoProfileListInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkVideoProfileListInfoKHR	calloc()	Returns a new VkVideoProfileListInfoKHR instance allocated with memCalloc.
static VkVideoProfileListInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoProfileListInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoProfileListInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoProfileListInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoProfileListInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoProfileListInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoProfileListInfoKHR	create()	Returns a new VkVideoProfileListInfoKHR instance allocated with BufferUtils.
static VkVideoProfileListInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoProfileListInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoProfileListInfoKHR	create(long address)	Returns a new VkVideoProfileListInfoKHR instance for the specified memory address.
static VkVideoProfileListInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoProfileListInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoProfileListInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoProfileListInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoProfileListInfoKHR	malloc()	Returns a new VkVideoProfileListInfoKHR instance allocated with memAlloc.
static VkVideoProfileListInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoProfileListInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoProfileListInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoProfileListInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoProfileListInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoProfileListInfoKHR instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable VkVideoProfileInfoKHR.Buffer	npProfiles(long struct)	Unsafe version of pProfiles().
static void	npProfiles(long struct, @Nullable VkVideoProfileInfoKHR.Buffer value)	Unsafe version of pProfiles.
static int	nprofileCount(long struct)	Unsafe version of profileCount().
static void	nprofileCount(long struct, int value)	Sets the specified value to the profileCount 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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVideoProfileListInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
@Nullable VkVideoProfileInfoKHR.Buffer	pProfiles()	a pointer to an array of VkVideoProfileInfoKHR structures.
VkVideoProfileListInfoKHR	pProfiles(@Nullable VkVideoProfileInfoKHR.Buffer value)	Sets the address of the specified VkVideoProfileInfoKHR.Buffer to the pProfiles() field.
int	profileCount()	the number of elements in the pProfiles array.
VkVideoProfileListInfoKHR	set(int sType, long pNext, @Nullable VkVideoProfileInfoKHR.Buffer pProfiles)	Initializes this struct with the specified values.
VkVideoProfileListInfoKHR	set(VkVideoProfileListInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoProfileListInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoProfileListInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_PROFILE_LIST_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.

PROFILECOUNT

public static final int PROFILECOUNT

The struct member offsets.

PPROFILES

public static final int PPROFILES

The struct member offsets.

Constructor Details

VkVideoProfileListInfoKHR

public VkVideoProfileListInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

profileCount

public int profileCount()

the number of elements in the pProfiles array.

pProfiles

public @Nullable VkVideoProfileInfoKHR.Buffer pProfiles()

a pointer to an array of VkVideoProfileInfoKHR structures.

sType

public VkVideoProfileListInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoProfileListInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_PROFILE_LIST_INFO_KHR value to the sType() field.

pNext

public VkVideoProfileListInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pProfiles

public VkVideoProfileListInfoKHR pProfiles(@Nullable VkVideoProfileInfoKHR.Buffer value)

Sets the address of the specified VkVideoProfileInfoKHR.Buffer to the pProfiles() field.

set

public VkVideoProfileListInfoKHR set(int sType,
 long pNext,
 @Nullable VkVideoProfileInfoKHR.Buffer pProfiles)

Initializes this struct with the specified values.

set

public VkVideoProfileListInfoKHR set(VkVideoProfileListInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoProfileListInfoKHR malloc()

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

calloc

public static VkVideoProfileListInfoKHR calloc()

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

create

public static VkVideoProfileListInfoKHR create()

Returns a new VkVideoProfileListInfoKHR instance allocated with BufferUtils.

create

public static VkVideoProfileListInfoKHR create(long address)

Returns a new VkVideoProfileListInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoProfileListInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoProfileListInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoProfileListInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoProfileListInfoKHR.Buffer create(int capacity)

Returns a new VkVideoProfileListInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoProfileListInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoProfileListInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nprofileCount

public static int nprofileCount(long struct)

Unsafe version of profileCount().

npProfiles

public static @Nullable VkVideoProfileInfoKHR.Buffer npProfiles(long struct)

Unsafe version of pProfiles().

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.

nprofileCount

public static void nprofileCount(long struct,
 int value)

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

npProfiles

public static void npProfiles(long struct,
 @Nullable VkVideoProfileInfoKHR.Buffer value)

Unsafe version of pProfiles.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate