Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoProfileListInfoKHR

extends Struct<VkVideoProfileListInfoKHR>
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 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
Valid Usage (Implicit)
See Also

VkVideoProfileInfoKHR

Layout


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

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
PNEXT

The struct member offsets.

public static final int
PPROFILES

The struct member offsets.

public static final int
PROFILECOUNT

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
VkVideoProfileListInfoKHR(long address, ByteBuffer container)

public
VkVideoProfileListInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkVideoProfileListInfoKHR
calloc()

Returns a new VkVideoProfileListInfoKHR instance allocated with memCalloc.

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

Returns a new VkVideoProfileListInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkVideoProfileListInfoKHR
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 VkVideoProfileListInfoKHR
create()

Returns a new VkVideoProfileListInfoKHR instance allocated with BufferUtils.

public static VkVideoProfileListInfoKHR
create(long address)

Returns a new VkVideoProfileListInfoKHR instance for the specified memory address.

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

Returns a new VkVideoProfileListInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkVideoProfileListInfoKHR.Buffer instance at the specified memory.

public static VkVideoProfileListInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkVideoProfileListInfoKHR
malloc()

Returns a new VkVideoProfileListInfoKHR instance allocated with memAlloc.

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

Returns a new VkVideoProfileListInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkVideoProfileListInfoKHR instance allocated on the specified MemoryStack.

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

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkVideoProfileInfoKHR.Buffer
npProfiles(long struct)

Unsafe version of pProfiles.

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

Unsafe version of pProfiles.

public static int
nprofileCount(long struct)

Unsafe version of profileCount.

public static void
nprofileCount(long struct, int value)

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

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkVideoProfileListInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkVideoProfileInfoKHR.Buffer
pProfiles()

a pointer to an array of VkVideoProfileInfoKHR structures.

public VkVideoProfileListInfoKHR
pProfiles(VkVideoProfileInfoKHR.Buffer value)

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

public int
profileCount()

the number of elements in the pProfiles array.

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

Initializes this struct with the specified values.

public VkVideoProfileListInfoKHR

Returns:

this struct
set
(VkVideoProfileListInfoKHR
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 VkVideoProfileListInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkVideoProfileListInfoKHR
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

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PPROFILESback to summary
public static final int PPROFILES

The struct member offsets.

PROFILECOUNTback to summary
public static final int PROFILECOUNT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkVideoProfileListInfoKHRback to summary
protected VkVideoProfileListInfoKHR(long address, ByteBuffer container)
VkVideoProfileListInfoKHRback to summary
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 Detail

callocback to summary
public static VkVideoProfileListInfoKHR calloc()

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

callocback to summary
public static VkVideoProfileListInfoKHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVideoProfileListInfoKHR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkVideoProfileListInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkVideoProfileListInfoKHR create(long address, ByteBuffer container)

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

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkVideoProfileListInfoKHR create()

Returns a new VkVideoProfileListInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkVideoProfileListInfoKHR create(long address)

Returns a new VkVideoProfileListInfoKHR instance for the specified memory address.

createback to summary
public static VkVideoProfileListInfoKHR.Buffer create(int capacity)

Returns a new VkVideoProfileListInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVideoProfileListInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVideoProfileListInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkVideoProfileListInfoKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkVideoProfileListInfoKHR malloc()

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

mallocback to summary
public static VkVideoProfileListInfoKHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVideoProfileListInfoKHR malloc(MemoryStack stack)

Returns a new VkVideoProfileListInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkVideoProfileListInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

npProfilesback to summary
public static VkVideoProfileInfoKHR.Buffer npProfiles(long struct)

Unsafe version of pProfiles.

Annotations
@Nullable
npProfilesback to summary
public static void npProfiles(long struct, VkVideoProfileInfoKHR.Buffer value)

Unsafe version of pProfiles.

nprofileCountback to summary
public static int nprofileCount(long struct)

Unsafe version of profileCount.

nprofileCountback to summary
public static void nprofileCount(long struct, int value)

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

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkVideoProfileListInfoKHR pNext(long value)

Sets the specified value to the pNext field.

pProfilesback to summary
public VkVideoProfileInfoKHR.Buffer pProfiles()

a pointer to an array of VkVideoProfileInfoKHR structures.

Annotations
@Nullable
@NativeType:VkVideoProfileInfoKHR const *
pProfilesback to summary
public VkVideoProfileListInfoKHR pProfiles(VkVideoProfileInfoKHR.Buffer value)

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

profileCountback to summary
public int profileCount()

the number of elements in the pProfiles array.

Annotations
@NativeType:uint32_t
setback to summary
public VkVideoProfileListInfoKHR set(int sType, long pNext, VkVideoProfileInfoKHR.Buffer pProfiles)

Initializes this struct with the specified values.

setback to summary
public VkVideoProfileListInfoKHR set(VkVideoProfileListInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkVideoProfileListInfoKHR

the source struct

Returns:VkVideoProfileListInfoKHR

this struct

sizeofback to summary
public int sizeof()

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

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkVideoProfileListInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkVideoProfileListInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_PROFILE_LIST_INFO_KHR value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkVideoProfileListInfoKHR.Buffer

extends StructBuffer<VkVideoProfileListInfoKHR, VkVideoProfileListInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkVideoProfileListInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkVideoProfileListInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkVideoProfileListInfoKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkVideoProfileListInfoKHR
public long

Returns:

the value of the VkVideoProfileListInfoKHR#pNext field.
pNext
()

public VkVideoProfileListInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkVideoProfileListInfoKHR#pNext field.

public VkVideoProfileInfoKHR.Buffer

Returns:

a VkVideoProfileInfoKHR.Buffer view of the struct array pointed to by the VkVideoProfileListInfoKHR#pProfiles field.
pProfiles
()

public VkVideoProfileListInfoKHR.Buffer
public int

Returns:

the value of the VkVideoProfileListInfoKHR#profileCount field.
profileCount
()

protected VkVideoProfileListInfoKHR.Buffer
public int

Returns:

the value of the VkVideoProfileListInfoKHR#sType field.
sType
()

public VkVideoProfileListInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkVideoProfileListInfoKHR#sType field.

public VkVideoProfileListInfoKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVideoProfileListInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkVideoProfileListInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkVideoProfileListInfoKHR#SIZEOF, and its mark will be undefined.

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

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkVideoProfileListInfoKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkVideoProfileListInfoKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkVideoProfileListInfoKHR.Buffer pNext(long value)

Sets the specified value to the VkVideoProfileListInfoKHR#pNext field.

pProfilesback to summary
public VkVideoProfileInfoKHR.Buffer pProfiles()
Returns:VkVideoProfileInfoKHR.Buffer

a VkVideoProfileInfoKHR.Buffer view of the struct array pointed to by the VkVideoProfileListInfoKHR#pProfiles field.

Annotations
@Nullable
@NativeType:VkVideoProfileInfoKHR const *
pProfilesback to summary
public VkVideoProfileListInfoKHR.Buffer pProfiles(VkVideoProfileInfoKHR.Buffer value)

Sets the address of the specified VkVideoProfileInfoKHR.Buffer to the VkVideoProfileListInfoKHR#pProfiles field.

profileCountback to summary
public int profileCount()
Returns:int

the value of the VkVideoProfileListInfoKHR#profileCount field.

Annotations
@NativeType:uint32_t
selfback to summary
protected VkVideoProfileListInfoKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkVideoProfileListInfoKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkVideoProfileListInfoKHR.Buffer sType(int value)

Sets the specified value to the VkVideoProfileListInfoKHR#sType field.

sType$Defaultback to summary
public VkVideoProfileListInfoKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_PROFILE_LIST_INFO_KHR value to the VkVideoProfileListInfoKHR#sType field.