Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoDecodeUsageInfoKHR

extends Struct<VkVideoDecodeUsageInfoKHR>
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 decode usage information.
Valid Usage (Implicit)

Layout


struct VkVideoDecodeUsageInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkVideoDecodeUsageFlagsKHR videoUsageHints;
}

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
VIDEOUSAGEHINTS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkVideoDecodeUsageInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkVideoDecodeUsageInfoKHR
calloc()

Returns a new VkVideoDecodeUsageInfoKHR instance allocated with memCalloc.

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

Returns a new VkVideoDecodeUsageInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkVideoDecodeUsageInfoKHR instance allocated with BufferUtils.

public static VkVideoDecodeUsageInfoKHR
create(long address)

Returns a new VkVideoDecodeUsageInfoKHR instance for the specified memory address.

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

Returns a new VkVideoDecodeUsageInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkVideoDecodeUsageInfoKHR.Buffer instance at the specified memory.

public static VkVideoDecodeUsageInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkVideoDecodeUsageInfoKHR
malloc()

Returns a new VkVideoDecodeUsageInfoKHR instance allocated with memAlloc.

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

Returns a new VkVideoDecodeUsageInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkVideoDecodeUsageInfoKHR instance allocated on the specified MemoryStack.

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

Returns a new VkVideoDecodeUsageInfoKHR.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
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 VkVideoDecodeUsageInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkVideoDecodeUsageInfoKHR
set(int sType, long pNext, int videoUsageHints)

Initializes this struct with the specified values.

public VkVideoDecodeUsageInfoKHR

Returns:

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

Sets the specified value to the sType field.

public VkVideoDecodeUsageInfoKHR
public int
videoUsageHints()

a bitmask of VkVideoDecodeUsageFlagBitsKHR specifying hints about the intended use of the video decode profile.

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

VIDEOUSAGEHINTSback to summary
public static final int VIDEOUSAGEHINTS

The struct member offsets.

Constructor Detail

VkVideoDecodeUsageInfoKHRback to summary
protected VkVideoDecodeUsageInfoKHR(long address, ByteBuffer container)
VkVideoDecodeUsageInfoKHRback to summary
public VkVideoDecodeUsageInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVideoDecodeUsageInfoKHR calloc(MemoryStack stack)

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

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

Returns a new VkVideoDecodeUsageInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkVideoDecodeUsageInfoKHR create(long address)

Returns a new VkVideoDecodeUsageInfoKHR instance for the specified memory address.

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

Returns a new VkVideoDecodeUsageInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVideoDecodeUsageInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVideoDecodeUsageInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVideoDecodeUsageInfoKHR malloc(MemoryStack stack)

Returns a new VkVideoDecodeUsageInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

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

Sets the specified value to the pNext field.

setback to summary
public VkVideoDecodeUsageInfoKHR set(int sType, long pNext, int videoUsageHints)

Initializes this struct with the specified values.

setback to summary
public VkVideoDecodeUsageInfoKHR set(VkVideoDecodeUsageInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkVideoDecodeUsageInfoKHR

the source struct

Returns:VkVideoDecodeUsageInfoKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_DECODE_USAGE_INFO_KHR value to the sType field.

videoUsageHintsback to summary
public int videoUsageHints()

a bitmask of VkVideoDecodeUsageFlagBitsKHR specifying hints about the intended use of the video decode profile.

Annotations
@NativeType:VkVideoDecodeUsageFlagsKHR
videoUsageHintsback to summary
public VkVideoDecodeUsageInfoKHR videoUsageHints(int value)

Sets the specified value to the videoUsageHints field.

org.lwjgl.vulkan back to summary

public Class VkVideoDecodeUsageInfoKHR.Buffer

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

An array of VkVideoDecodeUsageInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkVideoDecodeUsageInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public VkVideoDecodeUsageInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkVideoDecodeUsageInfoKHR#pNext field.

protected VkVideoDecodeUsageInfoKHR.Buffer
public int

Returns:

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

public VkVideoDecodeUsageInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkVideoDecodeUsageInfoKHR#sType field.

public VkVideoDecodeUsageInfoKHR.Buffer
public int
public VkVideoDecodeUsageInfoKHR.Buffer
videoUsageHints(int value)

Sets the specified value to the VkVideoDecodeUsageInfoKHR#videoUsageHints field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVideoDecodeUsageInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the VkVideoDecodeUsageInfoKHR#pNext field.

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

Sets the specified value to the VkVideoDecodeUsageInfoKHR#pNext field.

selfback to summary
protected VkVideoDecodeUsageInfoKHR.Buffer self()

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

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

the value of the VkVideoDecodeUsageInfoKHR#sType field.

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

Sets the specified value to the VkVideoDecodeUsageInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_DECODE_USAGE_INFO_KHR value to the VkVideoDecodeUsageInfoKHR#sType field.

videoUsageHintsback to summary
public int videoUsageHints()
Returns:int

the value of the VkVideoDecodeUsageInfoKHR#videoUsageHints field.

Annotations
@NativeType:VkVideoDecodeUsageFlagsKHR
videoUsageHintsback to summary
public VkVideoDecodeUsageInfoKHR.Buffer videoUsageHints(int value)

Sets the specified value to the VkVideoDecodeUsageInfoKHR#videoUsageHints field.