Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDrmFormatModifierPropertiesList2EXT

extends Struct<VkDrmFormatModifierPropertiesList2EXT>
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 the list of DRM format modifiers supported for a format.
Description

If pDrmFormatModifierProperties is NULL, the number of modifiers compatible with the queried format is returned in drmFormatModifierCount. Otherwise, the application must set drmFormatModifierCount to the length of the array pDrmFormatModifierProperties; the function will write at most drmFormatModifierCount elements to the array, and will return in drmFormatModifierCount the number of elements written.

Among the elements in array pDrmFormatModifierProperties, each returned drmFormatModifier must be unique.

Among the elements in array pDrmFormatModifierProperties, the bits reported in drmFormatModifierTilingFeatures must include the bits reported in the corresponding element of VkDrmFormatModifierPropertiesListEXT::pDrmFormatModifierProperties.

Valid Usage (Implicit)
See Also

VkDrmFormatModifierProperties2EXT

Layout


struct VkDrmFormatModifierPropertiesList2EXT {
    VkStructureType sType;
    void * pNext;
    uint32_t drmFormatModifierCount;
    VkDrmFormatModifierProperties2EXT * pDrmFormatModifierProperties;
}

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
DRMFORMATMODIFIERCOUNT

The struct member offsets.

public static final int
PDRMFORMATMODIFIERPROPERTIES

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

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

Method Summary

Modifier and TypeMethod and Description
public static VkDrmFormatModifierPropertiesList2EXT
calloc()

Returns a new VkDrmFormatModifierPropertiesList2EXT instance allocated with memCalloc.

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

Returns a new VkDrmFormatModifierPropertiesList2EXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkDrmFormatModifierPropertiesList2EXT instance allocated with BufferUtils.

public static VkDrmFormatModifierPropertiesList2EXT
create(long address)

Returns a new VkDrmFormatModifierPropertiesList2EXT instance for the specified memory address.

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

Returns a new VkDrmFormatModifierPropertiesList2EXT.Buffer instance allocated with BufferUtils.

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

Create a VkDrmFormatModifierPropertiesList2EXT.Buffer instance at the specified memory.

public static VkDrmFormatModifierPropertiesList2EXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
drmFormatModifierCount()

an inout parameter related to the number of modifiers compatible with the format, as described below.

public static VkDrmFormatModifierPropertiesList2EXT
malloc()

Returns a new VkDrmFormatModifierPropertiesList2EXT instance allocated with memAlloc.

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

Returns a new VkDrmFormatModifierPropertiesList2EXT.Buffer instance allocated with memAlloc.

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

Returns a new VkDrmFormatModifierPropertiesList2EXT instance allocated on the specified MemoryStack.

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

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

public static int
ndrmFormatModifierCount(long struct)

Unsafe version of drmFormatModifierCount.

public static VkDrmFormatModifierProperties2EXT.Buffer
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 VkDrmFormatModifierProperties2EXT.Buffer
pDrmFormatModifierProperties()

either NULL or a pointer to an array of VkDrmFormatModifierProperties2EXT structures.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkDrmFormatModifierPropertiesList2EXT
pNext(long value)

Sets the specified value to the pNext field.

public VkDrmFormatModifierPropertiesList2EXT
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkDrmFormatModifierPropertiesList2EXT

Returns:

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

Sets the specified value to the sType field.

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

DRMFORMATMODIFIERCOUNTback to summary
public static final int DRMFORMATMODIFIERCOUNT

The struct member offsets.

PDRMFORMATMODIFIERPROPERTIESback to summary
public static final int PDRMFORMATMODIFIERPROPERTIES

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

VkDrmFormatModifierPropertiesList2EXTback to summary
protected VkDrmFormatModifierPropertiesList2EXT(long address, ByteBuffer container)
VkDrmFormatModifierPropertiesList2EXTback to summary
public VkDrmFormatModifierPropertiesList2EXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDrmFormatModifierPropertiesList2EXT calloc(MemoryStack stack)

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

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

Returns a new VkDrmFormatModifierPropertiesList2EXT instance allocated with BufferUtils.

createback to summary
public static VkDrmFormatModifierPropertiesList2EXT create(long address)

Returns a new VkDrmFormatModifierPropertiesList2EXT instance for the specified memory address.

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

Returns a new VkDrmFormatModifierPropertiesList2EXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDrmFormatModifierPropertiesList2EXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDrmFormatModifierPropertiesList2EXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
drmFormatModifierCountback to summary
public int drmFormatModifierCount()

an inout parameter related to the number of modifiers compatible with the format, as described below.

Annotations
@NativeType:uint32_t
mallocback to summary
public static VkDrmFormatModifierPropertiesList2EXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDrmFormatModifierPropertiesList2EXT malloc(MemoryStack stack)

Returns a new VkDrmFormatModifierPropertiesList2EXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndrmFormatModifierCountback to summary
public static int ndrmFormatModifierCount(long struct)

Unsafe version of drmFormatModifierCount.

npDrmFormatModifierPropertiesback to summary
public static VkDrmFormatModifierProperties2EXT.Buffer npDrmFormatModifierProperties(long struct)

Unsafe version of pDrmFormatModifierProperties.

Annotations
@Nullable
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.

pDrmFormatModifierPropertiesback to summary
public VkDrmFormatModifierProperties2EXT.Buffer pDrmFormatModifierProperties()

either NULL or a pointer to an array of VkDrmFormatModifierProperties2EXT structures.

Annotations
@Nullable
@NativeType:VkDrmFormatModifierProperties2EXT *
pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkDrmFormatModifierPropertiesList2EXT set(VkDrmFormatModifierPropertiesList2EXT src)

Copies the specified struct data to this struct.

Parameters
src:VkDrmFormatModifierPropertiesList2EXT

the source struct

Returns:VkDrmFormatModifierPropertiesList2EXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_2_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDrmFormatModifierPropertiesList2EXT.Buffer

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

An array of VkDrmFormatModifierPropertiesList2EXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkDrmFormatModifierPropertiesList2EXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDrmFormatModifierPropertiesList2EXT.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
protected VkDrmFormatModifierPropertiesList2EXT
public VkDrmFormatModifierProperties2EXT.Buffer
public long

Returns:

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

public VkDrmFormatModifierPropertiesList2EXT.Buffer
pNext(long value)

Sets the specified value to the VkDrmFormatModifierPropertiesList2EXT#pNext field.

protected VkDrmFormatModifierPropertiesList2EXT.Buffer
public int

Returns:

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

public VkDrmFormatModifierPropertiesList2EXT.Buffer
sType(int value)

Sets the specified value to the VkDrmFormatModifierPropertiesList2EXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDrmFormatModifierPropertiesList2EXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

drmFormatModifierCountback to summary
public int drmFormatModifierCount()
Returns:int

the value of the VkDrmFormatModifierPropertiesList2EXT#drmFormatModifierCount field.

Annotations
@NativeType:uint32_t
getElementFactoryback to summary
protected VkDrmFormatModifierPropertiesList2EXT getElementFactory()

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

Annotations
@Override
pDrmFormatModifierPropertiesback to summary
public VkDrmFormatModifierProperties2EXT.Buffer pDrmFormatModifierProperties()
Returns:VkDrmFormatModifierProperties2EXT.Buffer

a VkDrmFormatModifierProperties2EXT.Buffer view of the struct array pointed to by the VkDrmFormatModifierPropertiesList2EXT#pDrmFormatModifierProperties field.

Annotations
@Nullable
@NativeType:VkDrmFormatModifierProperties2EXT *
pNextback to summary
public long pNext()
Returns:long

the value of the VkDrmFormatModifierPropertiesList2EXT#pNext field.

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

Sets the specified value to the VkDrmFormatModifierPropertiesList2EXT#pNext field.

selfback to summary
protected VkDrmFormatModifierPropertiesList2EXT.Buffer self()

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

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

the value of the VkDrmFormatModifierPropertiesList2EXT#sType field.

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

Sets the specified value to the VkDrmFormatModifierPropertiesList2EXT#sType field.

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

Sets the STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_2_EXT value to the VkDrmFormatModifierPropertiesList2EXT#sType field.