Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoEncodeUsageInfoKHR

extends Struct<VkVideoEncodeUsageInfoKHR>
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 video encode usage information.
Valid Usage (Implicit)

Layout


struct VkVideoEncodeUsageInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkVideoEncodeUsageFlagsKHR videoUsageHints;
    VkVideoEncodeContentFlagsKHR videoContentHints;
    VkVideoEncodeTuningModeKHR tuningMode;
}

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
TUNINGMODE

The struct member offsets.

public static final int
VIDEOCONTENTHINTS

The struct member offsets.

public static final int
VIDEOUSAGEHINTS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkVideoEncodeUsageInfoKHR(long address, ByteBuffer container)

public
VkVideoEncodeUsageInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkVideoEncodeUsageInfoKHR
calloc()

Returns a new VkVideoEncodeUsageInfoKHR instance allocated with memCalloc.

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

Returns a new VkVideoEncodeUsageInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkVideoEncodeUsageInfoKHR instance allocated with BufferUtils.

public static VkVideoEncodeUsageInfoKHR
create(long address)

Returns a new VkVideoEncodeUsageInfoKHR instance for the specified memory address.

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

Returns a new VkVideoEncodeUsageInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkVideoEncodeUsageInfoKHR.Buffer instance at the specified memory.

public static VkVideoEncodeUsageInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkVideoEncodeUsageInfoKHR
malloc()

Returns a new VkVideoEncodeUsageInfoKHR instance allocated with memAlloc.

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

Returns a new VkVideoEncodeUsageInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkVideoEncodeUsageInfoKHR instance allocated on the specified MemoryStack.

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

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

Unsafe version of tuningMode.

public static void
ntuningMode(long struct, int value)

Unsafe version of tuningMode.

public static int
nvideoContentHints(long struct)

Unsafe version of videoContentHints.

public static void
nvideoContentHints(long struct, int value)

Unsafe version of videoContentHints.

public static int
nvideoUsageHints(long struct)

Unsafe version of videoUsageHints.

public static void
nvideoUsageHints(long struct, int value)

Unsafe version of videoUsageHints.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkVideoEncodeUsageInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkVideoEncodeUsageInfoKHR
set(int sType, long pNext, int videoUsageHints, int videoContentHints, int tuningMode)

Initializes this struct with the specified values.

public VkVideoEncodeUsageInfoKHR

Returns:

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

Sets the specified value to the sType field.

public VkVideoEncodeUsageInfoKHR
public int
tuningMode()

a VkVideoEncodeTuningModeKHR value specifying the tuning mode to use when encoding with the video profile.

public VkVideoEncodeUsageInfoKHR
tuningMode(int value)

Sets the specified value to the tuningMode field.

public int
videoContentHints()

a bitmask of VkVideoEncodeContentFlagBitsKHR specifying hints about the content to be encoded using the video encode profile.

public VkVideoEncodeUsageInfoKHR
videoContentHints(int value)

Sets the specified value to the videoContentHints field.

public int
videoUsageHints()

a bitmask of VkVideoEncodeUsageFlagBitsKHR specifying hints about the intended use of the video encode profile.

public VkVideoEncodeUsageInfoKHR
videoUsageHints(int value)

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

TUNINGMODEback to summary
public static final int TUNINGMODE

The struct member offsets.

VIDEOCONTENTHINTSback to summary
public static final int VIDEOCONTENTHINTS

The struct member offsets.

VIDEOUSAGEHINTSback to summary
public static final int VIDEOUSAGEHINTS

The struct member offsets.

Constructor Detail

VkVideoEncodeUsageInfoKHRback to summary
protected VkVideoEncodeUsageInfoKHR(long address, ByteBuffer container)
VkVideoEncodeUsageInfoKHRback to summary
public VkVideoEncodeUsageInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVideoEncodeUsageInfoKHR calloc(MemoryStack stack)

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

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

Returns a new VkVideoEncodeUsageInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkVideoEncodeUsageInfoKHR create(long address)

Returns a new VkVideoEncodeUsageInfoKHR instance for the specified memory address.

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

Returns a new VkVideoEncodeUsageInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVideoEncodeUsageInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVideoEncodeUsageInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVideoEncodeUsageInfoKHR malloc(MemoryStack stack)

Returns a new VkVideoEncodeUsageInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

ntuningModeback to summary
public static int ntuningMode(long struct)

Unsafe version of tuningMode.

ntuningModeback to summary
public static void ntuningMode(long struct, int value)

Unsafe version of tuningMode.

nvideoContentHintsback to summary
public static int nvideoContentHints(long struct)

Unsafe version of videoContentHints.

nvideoContentHintsback to summary
public static void nvideoContentHints(long struct, int value)

Unsafe version of videoContentHints.

nvideoUsageHintsback to summary
public static int nvideoUsageHints(long struct)

Unsafe version of videoUsageHints.

nvideoUsageHintsback to summary
public static void nvideoUsageHints(long struct, int value)

Unsafe version of videoUsageHints.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkVideoEncodeUsageInfoKHR set(int sType, long pNext, int videoUsageHints, int videoContentHints, int tuningMode)

Initializes this struct with the specified values.

setback to summary
public VkVideoEncodeUsageInfoKHR set(VkVideoEncodeUsageInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkVideoEncodeUsageInfoKHR

the source struct

Returns:VkVideoEncodeUsageInfoKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_USAGE_INFO_KHR value to the sType field.

tuningModeback to summary
public int tuningMode()

a VkVideoEncodeTuningModeKHR value specifying the tuning mode to use when encoding with the video profile.

Annotations
@NativeType:VkVideoEncodeTuningModeKHR
tuningModeback to summary
public VkVideoEncodeUsageInfoKHR tuningMode(int value)

Sets the specified value to the tuningMode field.

videoContentHintsback to summary
public int videoContentHints()

a bitmask of VkVideoEncodeContentFlagBitsKHR specifying hints about the content to be encoded using the video encode profile.

Annotations
@NativeType:VkVideoEncodeContentFlagsKHR
videoContentHintsback to summary
public VkVideoEncodeUsageInfoKHR videoContentHints(int value)

Sets the specified value to the videoContentHints field.

videoUsageHintsback to summary
public int videoUsageHints()

a bitmask of VkVideoEncodeUsageFlagBitsKHR specifying hints about the intended use of the video encode profile.

Annotations
@NativeType:VkVideoEncodeUsageFlagsKHR
videoUsageHintsback to summary
public VkVideoEncodeUsageInfoKHR videoUsageHints(int value)

Sets the specified value to the videoUsageHints field.

org.lwjgl.vulkan back to summary

public Class VkVideoEncodeUsageInfoKHR.Buffer

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

An array of VkVideoEncodeUsageInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkVideoEncodeUsageInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public VkVideoEncodeUsageInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkVideoEncodeUsageInfoKHR#pNext field.

protected VkVideoEncodeUsageInfoKHR.Buffer
public int

Returns:

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

public VkVideoEncodeUsageInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkVideoEncodeUsageInfoKHR#sType field.

public VkVideoEncodeUsageInfoKHR.Buffer
public int

Returns:

the value of the VkVideoEncodeUsageInfoKHR#tuningMode field.
tuningMode
()

public VkVideoEncodeUsageInfoKHR.Buffer
tuningMode(int value)

Sets the specified value to the VkVideoEncodeUsageInfoKHR#tuningMode field.

public int
public VkVideoEncodeUsageInfoKHR.Buffer
videoContentHints(int value)

Sets the specified value to the VkVideoEncodeUsageInfoKHR#videoContentHints field.

public int
public VkVideoEncodeUsageInfoKHR.Buffer
videoUsageHints(int value)

Sets the specified value to the VkVideoEncodeUsageInfoKHR#videoUsageHints field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVideoEncodeUsageInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the VkVideoEncodeUsageInfoKHR#pNext field.

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

Sets the specified value to the VkVideoEncodeUsageInfoKHR#pNext field.

selfback to summary
protected VkVideoEncodeUsageInfoKHR.Buffer self()

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

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

the value of the VkVideoEncodeUsageInfoKHR#sType field.

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

Sets the specified value to the VkVideoEncodeUsageInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_USAGE_INFO_KHR value to the VkVideoEncodeUsageInfoKHR#sType field.

tuningModeback to summary
public int tuningMode()
Returns:int

the value of the VkVideoEncodeUsageInfoKHR#tuningMode field.

Annotations
@NativeType:VkVideoEncodeTuningModeKHR
tuningModeback to summary
public VkVideoEncodeUsageInfoKHR.Buffer tuningMode(int value)

Sets the specified value to the VkVideoEncodeUsageInfoKHR#tuningMode field.

videoContentHintsback to summary
public int videoContentHints()
Returns:int

the value of the VkVideoEncodeUsageInfoKHR#videoContentHints field.

Annotations
@NativeType:VkVideoEncodeContentFlagsKHR
videoContentHintsback to summary
public VkVideoEncodeUsageInfoKHR.Buffer videoContentHints(int value)

Sets the specified value to the VkVideoEncodeUsageInfoKHR#videoContentHints field.

videoUsageHintsback to summary
public int videoUsageHints()
Returns:int

the value of the VkVideoEncodeUsageInfoKHR#videoUsageHints field.

Annotations
@NativeType:VkVideoEncodeUsageFlagsKHR
videoUsageHintsback to summary
public VkVideoEncodeUsageInfoKHR.Buffer videoUsageHints(int value)

Sets the specified value to the VkVideoEncodeUsageInfoKHR#videoUsageHints field.