Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoEncodeH264SessionCreateInfoEXT

extends Struct<VkVideoEncodeH264SessionCreateInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*, org.lwjgl.vulkan.video.*

Structure specifies H.264 encode session parameters.
Valid Usage (Implicit)

Layout


struct VkVideoEncodeH264SessionCreateInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkBool32 useMaxLevelIdc;
    StdVideoH264LevelIdc maxLevelIdc;
}

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
MAXLEVELIDC

The struct member offsets.

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
USEMAXLEVELIDC

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkVideoEncodeH264SessionCreateInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkVideoEncodeH264SessionCreateInfoEXT
calloc()

Returns a new VkVideoEncodeH264SessionCreateInfoEXT instance allocated with memCalloc.

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

Returns a new VkVideoEncodeH264SessionCreateInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkVideoEncodeH264SessionCreateInfoEXT instance allocated with BufferUtils.

public static VkVideoEncodeH264SessionCreateInfoEXT
create(long address)

Returns a new VkVideoEncodeH264SessionCreateInfoEXT instance for the specified memory address.

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

Returns a new VkVideoEncodeH264SessionCreateInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkVideoEncodeH264SessionCreateInfoEXT.Buffer instance at the specified memory.

public static VkVideoEncodeH264SessionCreateInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkVideoEncodeH264SessionCreateInfoEXT
malloc()

Returns a new VkVideoEncodeH264SessionCreateInfoEXT instance allocated with memAlloc.

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

Returns a new VkVideoEncodeH264SessionCreateInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkVideoEncodeH264SessionCreateInfoEXT instance allocated on the specified MemoryStack.

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

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

public int
maxLevelIdc()

provides the upper bound on the H.264 level for the video bitstreams produced by the created video session.

public VkVideoEncodeH264SessionCreateInfoEXT
maxLevelIdc(int value)

Sets the specified value to the maxLevelIdc field.

public static int
nmaxLevelIdc(long struct)

Unsafe version of maxLevelIdc.

public static void
nmaxLevelIdc(long struct, int value)

Unsafe version of maxLevelIdc.

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 int
nuseMaxLevelIdc(long struct)

Unsafe version of useMaxLevelIdc.

public static void
nuseMaxLevelIdc(long struct, int value)

Unsafe version of useMaxLevelIdc.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkVideoEncodeH264SessionCreateInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkVideoEncodeH264SessionCreateInfoEXT

Returns:

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

Sets the specified value to the sType field.

public VkVideoEncodeH264SessionCreateInfoEXT
public boolean
useMaxLevelIdc()

indicates whether the value of maxLevelIdc should be used by the implementation.

public VkVideoEncodeH264SessionCreateInfoEXT
useMaxLevelIdc(boolean value)

Sets the specified value to the useMaxLevelIdc 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.

MAXLEVELIDCback to summary
public static final int MAXLEVELIDC

The struct member offsets.

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.

USEMAXLEVELIDCback to summary
public static final int USEMAXLEVELIDC

The struct member offsets.

Constructor Detail

VkVideoEncodeH264SessionCreateInfoEXTback to summary
protected VkVideoEncodeH264SessionCreateInfoEXT(long address, ByteBuffer container)
VkVideoEncodeH264SessionCreateInfoEXTback to summary
public VkVideoEncodeH264SessionCreateInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVideoEncodeH264SessionCreateInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkVideoEncodeH264SessionCreateInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkVideoEncodeH264SessionCreateInfoEXT create(long address)

Returns a new VkVideoEncodeH264SessionCreateInfoEXT instance for the specified memory address.

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

Returns a new VkVideoEncodeH264SessionCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVideoEncodeH264SessionCreateInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVideoEncodeH264SessionCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVideoEncodeH264SessionCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkVideoEncodeH264SessionCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

maxLevelIdcback to summary
public int maxLevelIdc()

provides the upper bound on the H.264 level for the video bitstreams produced by the created video session.

Annotations
@NativeType:StdVideoH264LevelIdc
maxLevelIdcback to summary
public VkVideoEncodeH264SessionCreateInfoEXT maxLevelIdc(int value)

Sets the specified value to the maxLevelIdc field.

nmaxLevelIdcback to summary
public static int nmaxLevelIdc(long struct)

Unsafe version of maxLevelIdc.

nmaxLevelIdcback to summary
public static void nmaxLevelIdc(long struct, int value)

Unsafe version of maxLevelIdc.

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.

nuseMaxLevelIdcback to summary
public static int nuseMaxLevelIdc(long struct)

Unsafe version of useMaxLevelIdc.

nuseMaxLevelIdcback to summary
public static void nuseMaxLevelIdc(long struct, int value)

Unsafe version of useMaxLevelIdc.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkVideoEncodeH264SessionCreateInfoEXT set(int sType, long pNext, boolean useMaxLevelIdc, int maxLevelIdc)

Initializes this struct with the specified values.

setback to summary
public VkVideoEncodeH264SessionCreateInfoEXT set(VkVideoEncodeH264SessionCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkVideoEncodeH264SessionCreateInfoEXT

the source struct

Returns:VkVideoEncodeH264SessionCreateInfoEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_EXT value to the sType field.

useMaxLevelIdcback to summary
public boolean useMaxLevelIdc()

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

Annotations
@NativeType:VkBool32
useMaxLevelIdcback to summary
public VkVideoEncodeH264SessionCreateInfoEXT useMaxLevelIdc(boolean value)

Sets the specified value to the useMaxLevelIdc field.

org.lwjgl.vulkan back to summary

public Class VkVideoEncodeH264SessionCreateInfoEXT.Buffer

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

An array of VkVideoEncodeH264SessionCreateInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkVideoEncodeH264SessionCreateInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkVideoEncodeH264SessionCreateInfoEXT.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 VkVideoEncodeH264SessionCreateInfoEXT
public int
public VkVideoEncodeH264SessionCreateInfoEXT.Buffer
maxLevelIdc(int value)

Sets the specified value to the VkVideoEncodeH264SessionCreateInfoEXT#maxLevelIdc field.

public long

Returns:

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

public VkVideoEncodeH264SessionCreateInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkVideoEncodeH264SessionCreateInfoEXT#pNext field.

protected VkVideoEncodeH264SessionCreateInfoEXT.Buffer
public int

Returns:

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

public VkVideoEncodeH264SessionCreateInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkVideoEncodeH264SessionCreateInfoEXT#sType field.

public VkVideoEncodeH264SessionCreateInfoEXT.Buffer
public boolean
public VkVideoEncodeH264SessionCreateInfoEXT.Buffer
useMaxLevelIdc(boolean value)

Sets the specified value to the VkVideoEncodeH264SessionCreateInfoEXT#useMaxLevelIdc field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVideoEncodeH264SessionCreateInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
maxLevelIdcback to summary
public int maxLevelIdc()
Returns:int

the value of the VkVideoEncodeH264SessionCreateInfoEXT#maxLevelIdc field.

Annotations
@NativeType:StdVideoH264LevelIdc
maxLevelIdcback to summary
public VkVideoEncodeH264SessionCreateInfoEXT.Buffer maxLevelIdc(int value)

Sets the specified value to the VkVideoEncodeH264SessionCreateInfoEXT#maxLevelIdc field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkVideoEncodeH264SessionCreateInfoEXT#pNext field.

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

Sets the specified value to the VkVideoEncodeH264SessionCreateInfoEXT#pNext field.

selfback to summary
protected VkVideoEncodeH264SessionCreateInfoEXT.Buffer self()

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

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

the value of the VkVideoEncodeH264SessionCreateInfoEXT#sType field.

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

Sets the specified value to the VkVideoEncodeH264SessionCreateInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_EXT value to the VkVideoEncodeH264SessionCreateInfoEXT#sType field.

useMaxLevelIdcback to summary
public boolean useMaxLevelIdc()
Returns:boolean

the value of the VkVideoEncodeH264SessionCreateInfoEXT#useMaxLevelIdc field.

Annotations
@NativeType:VkBool32
useMaxLevelIdcback to summary
public VkVideoEncodeH264SessionCreateInfoEXT.Buffer useMaxLevelIdc(boolean value)

Sets the specified value to the VkVideoEncodeH264SessionCreateInfoEXT#useMaxLevelIdc field.