Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageDrmFormatModifierListCreateInfoEXT

extends Struct<VkImageDrmFormatModifierListCreateInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Specify that an image must be created with a DRM format modifier from the provided list.
Valid Usage
Valid Usage (Implicit)

Layout


struct VkImageDrmFormatModifierListCreateInfoEXT {
    VkStructureType sType;
    void const * pNext;
    uint32_t drmFormatModifierCount;
    uint64_t const * pDrmFormatModifiers;
}

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
PDRMFORMATMODIFIERS

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

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

Method Summary

Modifier and TypeMethod and Description
public static VkImageDrmFormatModifierListCreateInfoEXT
calloc()

Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated with memCalloc.

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

Returns a new VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkImageDrmFormatModifierListCreateInfoEXT
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageDrmFormatModifierListCreateInfoEXT
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkImageDrmFormatModifierListCreateInfoEXT
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 VkImageDrmFormatModifierListCreateInfoEXT
create()

Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated with BufferUtils.

public static VkImageDrmFormatModifierListCreateInfoEXT
create(long address)

Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance for the specified memory address.

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

Returns a new VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance at the specified memory.

public static VkImageDrmFormatModifierListCreateInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
drmFormatModifierCount()

the length of the pDrmFormatModifiers array.

public static VkImageDrmFormatModifierListCreateInfoEXT
malloc()

Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated with memAlloc.

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

Returns a new VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated on the specified MemoryStack.

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

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

public static VkImageDrmFormatModifierListCreateInfoEXT
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageDrmFormatModifierListCreateInfoEXT
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
ndrmFormatModifierCount(long struct)

Unsafe version of drmFormatModifierCount.

public static void
ndrmFormatModifierCount(long struct, int value)

Sets the specified value to the drmFormatModifierCount field of the specified struct.

public static LongBuffer
npDrmFormatModifiers(long struct)

Unsafe version of pDrmFormatModifiers.

public static void
npDrmFormatModifiers(long struct, LongBuffer value)

Unsafe version of pDrmFormatModifiers.

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 LongBuffer
pDrmFormatModifiers()

a pointer to an array of Linux DRM format modifiers.

public VkImageDrmFormatModifierListCreateInfoEXT
pDrmFormatModifiers(LongBuffer value)

Sets the address of the specified LongBuffer to the pDrmFormatModifiers field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImageDrmFormatModifierListCreateInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkImageDrmFormatModifierListCreateInfoEXT
set(int sType, long pNext, LongBuffer pDrmFormatModifiers)

Initializes this struct with the specified values.

public VkImageDrmFormatModifierListCreateInfoEXT

Returns:

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

Sets the specified value to the sType field.

public VkImageDrmFormatModifierListCreateInfoEXT
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

PDRMFORMATMODIFIERSback to summary
public static final int PDRMFORMATMODIFIERS

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

VkImageDrmFormatModifierListCreateInfoEXTback to summary
protected VkImageDrmFormatModifierListCreateInfoEXT(long address, ByteBuffer container)
VkImageDrmFormatModifierListCreateInfoEXTback to summary
public VkImageDrmFormatModifierListCreateInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageDrmFormatModifierListCreateInfoEXT calloc(MemoryStack stack)

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

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

callocStackback to summary
public static VkImageDrmFormatModifierListCreateInfoEXT callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkImageDrmFormatModifierListCreateInfoEXT callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkImageDrmFormatModifierListCreateInfoEXT 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 VkImageDrmFormatModifierListCreateInfoEXT create()

Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkImageDrmFormatModifierListCreateInfoEXT create(long address)

Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance for the specified memory address.

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

Returns a new VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageDrmFormatModifierListCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
drmFormatModifierCountback to summary
public int drmFormatModifierCount()

the length of the pDrmFormatModifiers array.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageDrmFormatModifierListCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkImageDrmFormatModifierListCreateInfoEXT mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkImageDrmFormatModifierListCreateInfoEXT mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
ndrmFormatModifierCountback to summary
public static int ndrmFormatModifierCount(long struct)

Unsafe version of drmFormatModifierCount.

ndrmFormatModifierCountback to summary
public static void ndrmFormatModifierCount(long struct, int value)

Sets the specified value to the drmFormatModifierCount field of the specified struct.

npDrmFormatModifiersback to summary
public static LongBuffer npDrmFormatModifiers(long struct)

Unsafe version of pDrmFormatModifiers.

npDrmFormatModifiersback to summary
public static void npDrmFormatModifiers(long struct, LongBuffer value)

Unsafe version of pDrmFormatModifiers.

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.

pDrmFormatModifiersback to summary
public LongBuffer pDrmFormatModifiers()

a pointer to an array of Linux DRM format modifiers.

Annotations
@NativeType:uint64_t const *
pDrmFormatModifiersback to summary
public VkImageDrmFormatModifierListCreateInfoEXT pDrmFormatModifiers(LongBuffer value)

Sets the address of the specified LongBuffer to the pDrmFormatModifiers field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkImageDrmFormatModifierListCreateInfoEXT set(int sType, long pNext, LongBuffer pDrmFormatModifiers)

Initializes this struct with the specified values.

setback to summary
public VkImageDrmFormatModifierListCreateInfoEXT set(VkImageDrmFormatModifierListCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkImageDrmFormatModifierListCreateInfoEXT

the source struct

Returns:VkImageDrmFormatModifierListCreateInfoEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_LIST_CREATE_INFO_EXT value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkImageDrmFormatModifierListCreateInfoEXT.Buffer

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

An array of VkImageDrmFormatModifierListCreateInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkImageDrmFormatModifierListCreateInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImageDrmFormatModifierListCreateInfoEXT.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 VkImageDrmFormatModifierListCreateInfoEXT
public LongBuffer
public VkImageDrmFormatModifierListCreateInfoEXT.Buffer
public long

Returns:

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

public VkImageDrmFormatModifierListCreateInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkImageDrmFormatModifierListCreateInfoEXT#pNext field.

protected VkImageDrmFormatModifierListCreateInfoEXT.Buffer
public int

Returns:

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

public VkImageDrmFormatModifierListCreateInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkImageDrmFormatModifierListCreateInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageDrmFormatModifierListCreateInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkImageDrmFormatModifierListCreateInfoEXT.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 VkImageDrmFormatModifierListCreateInfoEXT#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 VkImageDrmFormatModifierListCreateInfoEXT#drmFormatModifierCount field.

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

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

Annotations
@Override
pDrmFormatModifiersback to summary
public LongBuffer pDrmFormatModifiers()
Returns:LongBuffer

a LongBuffer view of the data pointed to by the VkImageDrmFormatModifierListCreateInfoEXT#pDrmFormatModifiers field.

Annotations
@NativeType:uint64_t const *
pDrmFormatModifiersback to summary
public VkImageDrmFormatModifierListCreateInfoEXT.Buffer pDrmFormatModifiers(LongBuffer value)

Sets the address of the specified LongBuffer to the VkImageDrmFormatModifierListCreateInfoEXT#pDrmFormatModifiers field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkImageDrmFormatModifierListCreateInfoEXT#pNext field.

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

Sets the specified value to the VkImageDrmFormatModifierListCreateInfoEXT#pNext field.

selfback to summary
protected VkImageDrmFormatModifierListCreateInfoEXT.Buffer self()

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

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

the value of the VkImageDrmFormatModifierListCreateInfoEXT#sType field.

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

Sets the specified value to the VkImageDrmFormatModifierListCreateInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_LIST_CREATE_INFO_EXT value to the VkImageDrmFormatModifierListCreateInfoEXT#sType field.