Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoDecodeCapabilitiesKHR

extends Struct<VkVideoDecodeCapabilitiesKHR>
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 general video decode capabilities for a video profile.
Valid Usage (Implicit)

Layout


struct VkVideoDecodeCapabilitiesKHR {
    VkStructureType sType;
    void * pNext;
    VkVideoDecodeCapabilityFlagsKHR flags;
}

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
FLAGS

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.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkVideoDecodeCapabilitiesKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkVideoDecodeCapabilitiesKHR
calloc()

Returns a new VkVideoDecodeCapabilitiesKHR instance allocated with memCalloc.

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

Returns a new VkVideoDecodeCapabilitiesKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkVideoDecodeCapabilitiesKHR instance allocated with BufferUtils.

public static VkVideoDecodeCapabilitiesKHR
create(long address)

Returns a new VkVideoDecodeCapabilitiesKHR instance for the specified memory address.

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

Returns a new VkVideoDecodeCapabilitiesKHR.Buffer instance allocated with BufferUtils.

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

Create a VkVideoDecodeCapabilitiesKHR.Buffer instance at the specified memory.

public static VkVideoDecodeCapabilitiesKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

a bitmask of VkVideoDecodeCapabilityFlagBitsKHR describing the supported video decoding capabilities.

public static VkVideoDecodeCapabilitiesKHR
malloc()

Returns a new VkVideoDecodeCapabilitiesKHR instance allocated with memAlloc.

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

Returns a new VkVideoDecodeCapabilitiesKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkVideoDecodeCapabilitiesKHR instance allocated on the specified MemoryStack.

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

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

public static int
nflags(long struct)

Unsafe version of flags.

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

NULL or a pointer to a structure extending this structure.

public VkVideoDecodeCapabilitiesKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkVideoDecodeCapabilitiesKHR
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkVideoDecodeCapabilitiesKHR

Returns:

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

Sets the specified value to the sType field.

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

FLAGSback to summary
public static final int FLAGS

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.

Constructor Detail

VkVideoDecodeCapabilitiesKHRback to summary
protected VkVideoDecodeCapabilitiesKHR(long address, ByteBuffer container)
VkVideoDecodeCapabilitiesKHRback to summary
public VkVideoDecodeCapabilitiesKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVideoDecodeCapabilitiesKHR calloc(MemoryStack stack)

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

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

Returns a new VkVideoDecodeCapabilitiesKHR instance allocated with BufferUtils.

createback to summary
public static VkVideoDecodeCapabilitiesKHR create(long address)

Returns a new VkVideoDecodeCapabilitiesKHR instance for the specified memory address.

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

Returns a new VkVideoDecodeCapabilitiesKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVideoDecodeCapabilitiesKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVideoDecodeCapabilitiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

a bitmask of VkVideoDecodeCapabilityFlagBitsKHR describing the supported video decoding capabilities.

Annotations
@NativeType:VkVideoDecodeCapabilityFlagsKHR
mallocback to summary
public static VkVideoDecodeCapabilitiesKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVideoDecodeCapabilitiesKHR malloc(MemoryStack stack)

Returns a new VkVideoDecodeCapabilitiesKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkVideoDecodeCapabilitiesKHR set(VkVideoDecodeCapabilitiesKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkVideoDecodeCapabilitiesKHR

the source struct

Returns:VkVideoDecodeCapabilitiesKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_DECODE_CAPABILITIES_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkVideoDecodeCapabilitiesKHR.Buffer

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

An array of VkVideoDecodeCapabilitiesKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkVideoDecodeCapabilitiesKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkVideoDecodeCapabilitiesKHR.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
public int

Returns:

the value of the VkVideoDecodeCapabilitiesKHR#flags field.
flags
()

protected VkVideoDecodeCapabilitiesKHR
public long

Returns:

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

public VkVideoDecodeCapabilitiesKHR.Buffer
pNext(long value)

Sets the specified value to the VkVideoDecodeCapabilitiesKHR#pNext field.

protected VkVideoDecodeCapabilitiesKHR.Buffer
public int

Returns:

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

public VkVideoDecodeCapabilitiesKHR.Buffer
sType(int value)

Sets the specified value to the VkVideoDecodeCapabilitiesKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVideoDecodeCapabilitiesKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkVideoDecodeCapabilitiesKHR.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 VkVideoDecodeCapabilitiesKHR#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

flagsback to summary
public int flags()
Returns:int

the value of the VkVideoDecodeCapabilitiesKHR#flags field.

Annotations
@NativeType:VkVideoDecodeCapabilityFlagsKHR
getElementFactoryback to summary
protected VkVideoDecodeCapabilitiesKHR getElementFactory()

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

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

the value of the VkVideoDecodeCapabilitiesKHR#pNext field.

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

Sets the specified value to the VkVideoDecodeCapabilitiesKHR#pNext field.

selfback to summary
protected VkVideoDecodeCapabilitiesKHR.Buffer self()

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

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

the value of the VkVideoDecodeCapabilitiesKHR#sType field.

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

Sets the specified value to the VkVideoDecodeCapabilitiesKHR#sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_DECODE_CAPABILITIES_KHR value to the VkVideoDecodeCapabilitiesKHR#sType field.