Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoEncodeSessionParametersGetInfoKHR

extends Struct<VkVideoEncodeSessionParametersGetInfoKHR>
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 parameters for retrieving encoded video session parameter data.
Description

Depending on the used video encode operation, additional codec-specific structures may need to be included in the pNext chain of this structure to identify the specific video session parameters to retrieve encoded parameter data for, as described in the corresponding sections.

Valid Usage (Implicit)
See Also

GetEncodedVideoSessionParametersKHR

Layout


struct VkVideoEncodeSessionParametersGetInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkVideoSessionParametersKHR videoSessionParameters;
}

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
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
VIDEOSESSIONPARAMETERS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkVideoEncodeSessionParametersGetInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkVideoEncodeSessionParametersGetInfoKHR
calloc()

Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance allocated with memCalloc.

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

Returns a new VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance allocated with BufferUtils.

public static VkVideoEncodeSessionParametersGetInfoKHR
create(long address)

Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance for the specified memory address.

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

Returns a new VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance at the specified memory.

public static VkVideoEncodeSessionParametersGetInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkVideoEncodeSessionParametersGetInfoKHR
malloc()

Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance allocated with memAlloc.

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

Returns a new VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance allocated on the specified MemoryStack.

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

Returns a new VkVideoEncodeSessionParametersGetInfoKHR.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 int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static long
nvideoSessionParameters(long struct)

Unsafe version of videoSessionParameters.

public static void
nvideoSessionParameters(long struct, long value)

Unsafe version of videoSessionParameters.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkVideoEncodeSessionParametersGetInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkVideoEncodeSessionParametersGetInfoKHR
public VkVideoEncodeSessionParametersGetInfoKHR
public VkVideoEncodeSessionParametersGetInfoKHR
set(int sType, long pNext, long videoSessionParameters)

Initializes this struct with the specified values.

public VkVideoEncodeSessionParametersGetInfoKHR

Returns:

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

Sets the specified value to the sType field.

public VkVideoEncodeSessionParametersGetInfoKHR
public long
videoSessionParameters()

the VkVideoSessionParametersKHR object to retrieve encoded parameter data from.

public VkVideoEncodeSessionParametersGetInfoKHR
videoSessionParameters(long value)

Sets the specified value to the videoSessionParameters field.

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.

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.

VIDEOSESSIONPARAMETERSback to summary
public static final int VIDEOSESSIONPARAMETERS

The struct member offsets.

Constructor Detail

VkVideoEncodeSessionParametersGetInfoKHRback to summary
protected VkVideoEncodeSessionParametersGetInfoKHR(long address, ByteBuffer container)
VkVideoEncodeSessionParametersGetInfoKHRback to summary
public VkVideoEncodeSessionParametersGetInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVideoEncodeSessionParametersGetInfoKHR calloc(MemoryStack stack)

Returns a new VkVideoEncodeSessionParametersGetInfoKHR 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 VkVideoEncodeSessionParametersGetInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkVideoEncodeSessionParametersGetInfoKHR create(long address)

Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance for the specified memory address.

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

Returns a new VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVideoEncodeSessionParametersGetInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVideoEncodeSessionParametersGetInfoKHR malloc(MemoryStack stack)

Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkVideoEncodeSessionParametersGetInfoKHR.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.

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.

nvideoSessionParametersback to summary
public static long nvideoSessionParameters(long struct)

Unsafe version of videoSessionParameters.

nvideoSessionParametersback to summary
public static void nvideoSessionParameters(long struct, long value)

Unsafe version of videoSessionParameters.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

pNextback to summary
public VkVideoEncodeSessionParametersGetInfoKHR pNext(VkVideoEncodeH264SessionParametersGetInfoEXT value)

Prepends the specified VkVideoEncodeH264SessionParametersGetInfoEXT value to the pNext chain.

pNextback to summary
public VkVideoEncodeSessionParametersGetInfoKHR pNext(VkVideoEncodeH265SessionParametersGetInfoEXT value)

Prepends the specified VkVideoEncodeH265SessionParametersGetInfoEXT value to the pNext chain.

setback to summary
public VkVideoEncodeSessionParametersGetInfoKHR set(int sType, long pNext, long videoSessionParameters)

Initializes this struct with the specified values.

setback to summary
public VkVideoEncodeSessionParametersGetInfoKHR set(VkVideoEncodeSessionParametersGetInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkVideoEncodeSessionParametersGetInfoKHR

the source struct

Returns:VkVideoEncodeSessionParametersGetInfoKHR

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 VkVideoEncodeSessionParametersGetInfoKHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_SESSION_PARAMETERS_GET_INFO_KHR value to the sType field.

videoSessionParametersback to summary
public long videoSessionParameters()

the VkVideoSessionParametersKHR object to retrieve encoded parameter data from.

Annotations
@NativeType:VkVideoSessionParametersKHR
videoSessionParametersback to summary
public VkVideoEncodeSessionParametersGetInfoKHR videoSessionParameters(long value)

Sets the specified value to the videoSessionParameters field.

org.lwjgl.vulkan back to summary

public Class VkVideoEncodeSessionParametersGetInfoKHR.Buffer

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

An array of VkVideoEncodeSessionParametersGetInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkVideoEncodeSessionParametersGetInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkVideoEncodeSessionParametersGetInfoKHR.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 VkVideoEncodeSessionParametersGetInfoKHR
public long

Returns:

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

public VkVideoEncodeSessionParametersGetInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkVideoEncodeSessionParametersGetInfoKHR#pNext field.

public VkVideoEncodeSessionParametersGetInfoKHR.Buffer
public VkVideoEncodeSessionParametersGetInfoKHR.Buffer
protected VkVideoEncodeSessionParametersGetInfoKHR.Buffer
public int

Returns:

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

public VkVideoEncodeSessionParametersGetInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkVideoEncodeSessionParametersGetInfoKHR#sType field.

public VkVideoEncodeSessionParametersGetInfoKHR.Buffer
public long
public VkVideoEncodeSessionParametersGetInfoKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVideoEncodeSessionParametersGetInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkVideoEncodeSessionParametersGetInfoKHR.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 VkVideoEncodeSessionParametersGetInfoKHR#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 VkVideoEncodeSessionParametersGetInfoKHR getElementFactory()

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

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

the value of the VkVideoEncodeSessionParametersGetInfoKHR#pNext field.

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

Sets the specified value to the VkVideoEncodeSessionParametersGetInfoKHR#pNext field.

pNextback to summary
public VkVideoEncodeSessionParametersGetInfoKHR.Buffer pNext(VkVideoEncodeH264SessionParametersGetInfoEXT value)

Prepends the specified VkVideoEncodeH264SessionParametersGetInfoEXT value to the pNext chain.

pNextback to summary
public VkVideoEncodeSessionParametersGetInfoKHR.Buffer pNext(VkVideoEncodeH265SessionParametersGetInfoEXT value)

Prepends the specified VkVideoEncodeH265SessionParametersGetInfoEXT value to the pNext chain.

selfback to summary
protected VkVideoEncodeSessionParametersGetInfoKHR.Buffer self()

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

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

the value of the VkVideoEncodeSessionParametersGetInfoKHR#sType field.

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

Sets the specified value to the VkVideoEncodeSessionParametersGetInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_SESSION_PARAMETERS_GET_INFO_KHR value to the VkVideoEncodeSessionParametersGetInfoKHR#sType field.

videoSessionParametersback to summary
public long videoSessionParameters()
Returns:long

the value of the VkVideoEncodeSessionParametersGetInfoKHR#videoSessionParameters field.

Annotations
@NativeType:VkVideoSessionParametersKHR
videoSessionParametersback to summary
public VkVideoEncodeSessionParametersGetInfoKHR.Buffer videoSessionParameters(long value)

Sets the specified value to the VkVideoEncodeSessionParametersGetInfoKHR#videoSessionParameters field.