Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkQueueFamilyVideoPropertiesKHR

extends Struct<VkQueueFamilyVideoPropertiesKHR>
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 video codec operations supported by a queue family.
Description

If this structure is included in the pNext chain of the VkQueueFamilyProperties2 structure passed to GetPhysicalDeviceQueueFamilyProperties2, then it is filled with the set of video codec operations supported by the specified queue family.

Valid Usage (Implicit)

Layout


struct VkQueueFamilyVideoPropertiesKHR {
    VkStructureType sType;
    void * pNext;
    VkVideoCodecOperationFlagsKHR videoCodecOperations;
}

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
VIDEOCODECOPERATIONS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkQueueFamilyVideoPropertiesKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkQueueFamilyVideoPropertiesKHR
calloc()

Returns a new VkQueueFamilyVideoPropertiesKHR instance allocated with memCalloc.

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

Returns a new VkQueueFamilyVideoPropertiesKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkQueueFamilyVideoPropertiesKHR instance allocated with BufferUtils.

public static VkQueueFamilyVideoPropertiesKHR
create(long address)

Returns a new VkQueueFamilyVideoPropertiesKHR instance for the specified memory address.

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

Returns a new VkQueueFamilyVideoPropertiesKHR.Buffer instance allocated with BufferUtils.

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

Create a VkQueueFamilyVideoPropertiesKHR.Buffer instance at the specified memory.

public static VkQueueFamilyVideoPropertiesKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkQueueFamilyVideoPropertiesKHR
malloc()

Returns a new VkQueueFamilyVideoPropertiesKHR instance allocated with memAlloc.

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

Returns a new VkQueueFamilyVideoPropertiesKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkQueueFamilyVideoPropertiesKHR instance allocated on the specified MemoryStack.

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

Returns a new VkQueueFamilyVideoPropertiesKHR.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
nvideoCodecOperations(long struct)

Unsafe version of videoCodecOperations.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkQueueFamilyVideoPropertiesKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkQueueFamilyVideoPropertiesKHR
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkQueueFamilyVideoPropertiesKHR

Returns:

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

Sets the specified value to the sType field.

public VkQueueFamilyVideoPropertiesKHR
public int
videoCodecOperations()

a bitmask of VkVideoCodecOperationFlagBitsKHR that indicates the set of video codec operations supported by the queue family.

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.

VIDEOCODECOPERATIONSback to summary
public static final int VIDEOCODECOPERATIONS

The struct member offsets.

Constructor Detail

VkQueueFamilyVideoPropertiesKHRback to summary
protected VkQueueFamilyVideoPropertiesKHR(long address, ByteBuffer container)
VkQueueFamilyVideoPropertiesKHRback to summary
public VkQueueFamilyVideoPropertiesKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkQueueFamilyVideoPropertiesKHR calloc(MemoryStack stack)

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

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

Returns a new VkQueueFamilyVideoPropertiesKHR instance allocated with BufferUtils.

createback to summary
public static VkQueueFamilyVideoPropertiesKHR create(long address)

Returns a new VkQueueFamilyVideoPropertiesKHR instance for the specified memory address.

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

Returns a new VkQueueFamilyVideoPropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkQueueFamilyVideoPropertiesKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkQueueFamilyVideoPropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkQueueFamilyVideoPropertiesKHR malloc(MemoryStack stack)

Returns a new VkQueueFamilyVideoPropertiesKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

nvideoCodecOperationsback to summary
public static int nvideoCodecOperations(long struct)

Unsafe version of videoCodecOperations.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkQueueFamilyVideoPropertiesKHR set(VkQueueFamilyVideoPropertiesKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkQueueFamilyVideoPropertiesKHR

the source struct

Returns:VkQueueFamilyVideoPropertiesKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_QUEUE_FAMILY_VIDEO_PROPERTIES_KHR value to the sType field.

videoCodecOperationsback to summary
public int videoCodecOperations()

a bitmask of VkVideoCodecOperationFlagBitsKHR that indicates the set of video codec operations supported by the queue family.

Annotations
@NativeType:VkVideoCodecOperationFlagsKHR
org.lwjgl.vulkan back to summary

public Class VkQueueFamilyVideoPropertiesKHR.Buffer

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

An array of VkQueueFamilyVideoPropertiesKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkQueueFamilyVideoPropertiesKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public VkQueueFamilyVideoPropertiesKHR.Buffer
pNext(long value)

Sets the specified value to the VkQueueFamilyVideoPropertiesKHR#pNext field.

protected VkQueueFamilyVideoPropertiesKHR.Buffer
public int

Returns:

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

public VkQueueFamilyVideoPropertiesKHR.Buffer
sType(int value)

Sets the specified value to the VkQueueFamilyVideoPropertiesKHR#sType field.

public VkQueueFamilyVideoPropertiesKHR.Buffer
public int
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkQueueFamilyVideoPropertiesKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the VkQueueFamilyVideoPropertiesKHR#pNext field.

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

Sets the specified value to the VkQueueFamilyVideoPropertiesKHR#pNext field.

selfback to summary
protected VkQueueFamilyVideoPropertiesKHR.Buffer self()

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

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

the value of the VkQueueFamilyVideoPropertiesKHR#sType field.

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

Sets the specified value to the VkQueueFamilyVideoPropertiesKHR#sType field.

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

Sets the STRUCTURE_TYPE_QUEUE_FAMILY_VIDEO_PROPERTIES_KHR value to the VkQueueFamilyVideoPropertiesKHR#sType field.

videoCodecOperationsback to summary
public int videoCodecOperations()
Returns:int

the value of the VkQueueFamilyVideoPropertiesKHR#videoCodecOperations field.

Annotations
@NativeType:VkVideoCodecOperationFlagsKHR