Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoEncodeQualityLevelPropertiesKHR

extends Struct<VkVideoEncodeQualityLevelPropertiesKHR>
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 describing the video encode quality level properties.
Valid Usage (Implicit)
See Also

GetPhysicalDeviceVideoEncodeQualityLevelPropertiesKHR

Layout


struct VkVideoEncodeQualityLevelPropertiesKHR {
    VkStructureType sType;
    void * pNext;
    VkVideoEncodeRateControlModeFlagBitsKHR preferredRateControlMode;
    uint32_t preferredRateControlLayerCount;
}

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
PREFERREDRATECONTROLLAYERCOUNT

The struct member offsets.

public static final int
PREFERREDRATECONTROLMODE

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
public
VkVideoEncodeQualityLevelPropertiesKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkVideoEncodeQualityLevelPropertiesKHR
calloc()

Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance allocated with memCalloc.

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

Returns a new VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance allocated with BufferUtils.

public static VkVideoEncodeQualityLevelPropertiesKHR
create(long address)

Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance for the specified memory address.

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

Returns a new VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance allocated with BufferUtils.

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

Create a VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance at the specified memory.

public static VkVideoEncodeQualityLevelPropertiesKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkVideoEncodeQualityLevelPropertiesKHR
malloc()

Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance allocated with memAlloc.

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

Returns a new VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance allocated on the specified MemoryStack.

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

Returns a new VkVideoEncodeQualityLevelPropertiesKHR.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
public static int
npreferredRateControlMode(long struct)

Unsafe version of preferredRateControlMode.

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 VkVideoEncodeQualityLevelPropertiesKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkVideoEncodeQualityLevelPropertiesKHR
public VkVideoEncodeQualityLevelPropertiesKHR
public int
preferredRateControlLayerCount()

indicates the preferred number of rate control layers to use with the quality level.

public int
preferredRateControlMode()

a VkVideoEncodeRateControlModeFlagBitsKHR value indicating the preferred rate control mode to use with the video encode quality level.

public VkVideoEncodeQualityLevelPropertiesKHR
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkVideoEncodeQualityLevelPropertiesKHR

Returns:

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

Sets the specified value to the sType field.

public VkVideoEncodeQualityLevelPropertiesKHR
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.

PREFERREDRATECONTROLLAYERCOUNTback to summary
public static final int PREFERREDRATECONTROLLAYERCOUNT

The struct member offsets.

PREFERREDRATECONTROLMODEback to summary
public static final int PREFERREDRATECONTROLMODE

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

VkVideoEncodeQualityLevelPropertiesKHRback to summary
protected VkVideoEncodeQualityLevelPropertiesKHR(long address, ByteBuffer container)
VkVideoEncodeQualityLevelPropertiesKHRback to summary
public VkVideoEncodeQualityLevelPropertiesKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVideoEncodeQualityLevelPropertiesKHR calloc(MemoryStack stack)

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

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

Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance allocated with BufferUtils.

createback to summary
public static VkVideoEncodeQualityLevelPropertiesKHR create(long address)

Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance for the specified memory address.

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

Returns a new VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVideoEncodeQualityLevelPropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVideoEncodeQualityLevelPropertiesKHR malloc(MemoryStack stack)

Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

npreferredRateControlLayerCountback to summary
public static int npreferredRateControlLayerCount(long struct)

Unsafe version of preferredRateControlLayerCount.

npreferredRateControlModeback to summary
public static int npreferredRateControlMode(long struct)

Unsafe version of preferredRateControlMode.

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 *
pNextback to summary
public VkVideoEncodeQualityLevelPropertiesKHR pNext(long value)

Sets the specified value to the pNext field.

pNextback to summary
public VkVideoEncodeQualityLevelPropertiesKHR pNext(VkVideoEncodeH264QualityLevelPropertiesEXT value)

Prepends the specified VkVideoEncodeH264QualityLevelPropertiesEXT value to the pNext chain.

pNextback to summary
public VkVideoEncodeQualityLevelPropertiesKHR pNext(VkVideoEncodeH265QualityLevelPropertiesEXT value)

Prepends the specified VkVideoEncodeH265QualityLevelPropertiesEXT value to the pNext chain.

preferredRateControlLayerCountback to summary
public int preferredRateControlLayerCount()

indicates the preferred number of rate control layers to use with the quality level.

Annotations
@NativeType:uint32_t
preferredRateControlModeback to summary
public int preferredRateControlMode()

a VkVideoEncodeRateControlModeFlagBitsKHR value indicating the preferred rate control mode to use with the video encode quality level.

Annotations
@NativeType:VkVideoEncodeRateControlModeFlagBitsKHR
setback to summary
public VkVideoEncodeQualityLevelPropertiesKHR set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkVideoEncodeQualityLevelPropertiesKHR set(VkVideoEncodeQualityLevelPropertiesKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkVideoEncodeQualityLevelPropertiesKHR

the source struct

Returns:VkVideoEncodeQualityLevelPropertiesKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_QUALITY_LEVEL_PROPERTIES_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkVideoEncodeQualityLevelPropertiesKHR.Buffer

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

An array of VkVideoEncodeQualityLevelPropertiesKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkVideoEncodeQualityLevelPropertiesKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public VkVideoEncodeQualityLevelPropertiesKHR.Buffer
pNext(long value)

Sets the specified value to the VkVideoEncodeQualityLevelPropertiesKHR#pNext field.

public VkVideoEncodeQualityLevelPropertiesKHR.Buffer
public VkVideoEncodeQualityLevelPropertiesKHR.Buffer
public int
public int
protected VkVideoEncodeQualityLevelPropertiesKHR.Buffer
public int

Returns:

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

public VkVideoEncodeQualityLevelPropertiesKHR.Buffer
sType(int value)

Sets the specified value to the VkVideoEncodeQualityLevelPropertiesKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVideoEncodeQualityLevelPropertiesKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the VkVideoEncodeQualityLevelPropertiesKHR#pNext field.

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

Sets the specified value to the VkVideoEncodeQualityLevelPropertiesKHR#pNext field.

pNextback to summary
public VkVideoEncodeQualityLevelPropertiesKHR.Buffer pNext(VkVideoEncodeH264QualityLevelPropertiesEXT value)

Prepends the specified VkVideoEncodeH264QualityLevelPropertiesEXT value to the pNext chain.

pNextback to summary
public VkVideoEncodeQualityLevelPropertiesKHR.Buffer pNext(VkVideoEncodeH265QualityLevelPropertiesEXT value)

Prepends the specified VkVideoEncodeH265QualityLevelPropertiesEXT value to the pNext chain.

preferredRateControlLayerCountback to summary
public int preferredRateControlLayerCount()
Returns:int

the value of the VkVideoEncodeQualityLevelPropertiesKHR#preferredRateControlLayerCount field.

Annotations
@NativeType:uint32_t
preferredRateControlModeback to summary
public int preferredRateControlMode()
Returns:int

the value of the VkVideoEncodeQualityLevelPropertiesKHR#preferredRateControlMode field.

Annotations
@NativeType:VkVideoEncodeRateControlModeFlagBitsKHR
selfback to summary
protected VkVideoEncodeQualityLevelPropertiesKHR.Buffer self()

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

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

the value of the VkVideoEncodeQualityLevelPropertiesKHR#sType field.

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

Sets the specified value to the VkVideoEncodeQualityLevelPropertiesKHR#sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_QUALITY_LEVEL_PROPERTIES_KHR value to the VkVideoEncodeQualityLevelPropertiesKHR#sType field.