Package org.lwjgl.vulkan

Class VkImageDrmFormatModifierListCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageDrmFormatModifierListCreateInfoEXT>

org.lwjgl.vulkan.VkImageDrmFormatModifierListCreateInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkImageDrmFormatModifierListCreateInfoEXT
extends org.lwjgl.system.Struct<VkImageDrmFormatModifierListCreateInfoEXT>
implements org.lwjgl.system.NativeResource

Specify that an image must be created with a DRM format modifier from the provided list.

Valid Usage

• Each modifier in pDrmFormatModifiers must be compatible with the parameters in VkImageCreateInfo and its pNext chain, as determined by querying VkPhysicalDeviceImageFormatInfo2 extended with VkPhysicalDeviceImageDrmFormatModifierInfoEXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_LIST_CREATE_INFO_EXT
• pDrmFormatModifiers must be a valid pointer to an array of drmFormatModifierCount uint64_t values
• drmFormatModifierCount must be greater than 0

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageDrmFormatModifierListCreateInfoEXT.Buffer	An array of VkImageDrmFormatModifierListCreateInfoEXT structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DRMFORMATMODIFIERCOUNT	The struct member offsets.
static final int	PDRMFORMATMODIFIERS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkImageDrmFormatModifierListCreateInfoEXT(ByteBuffer container)	Creates a VkImageDrmFormatModifierListCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkImageDrmFormatModifierListCreateInfoEXT	calloc()	Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated with memCalloc.
static VkImageDrmFormatModifierListCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkImageDrmFormatModifierListCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageDrmFormatModifierListCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageDrmFormatModifierListCreateInfoEXT	callocStack()	Deprecated.
static VkImageDrmFormatModifierListCreateInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkImageDrmFormatModifierListCreateInfoEXT.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageDrmFormatModifierListCreateInfoEXT	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageDrmFormatModifierListCreateInfoEXT	create()	Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated with BufferUtils.
static VkImageDrmFormatModifierListCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkImageDrmFormatModifierListCreateInfoEXT	create(long address)	Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance for the specified memory address.
static VkImageDrmFormatModifierListCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkImageDrmFormatModifierListCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImageDrmFormatModifierListCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	drmFormatModifierCount()	the length of the pDrmFormatModifiers array.
static VkImageDrmFormatModifierListCreateInfoEXT	malloc()	Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated with memAlloc.
static VkImageDrmFormatModifierListCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkImageDrmFormatModifierListCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkImageDrmFormatModifierListCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated on the specified MemoryStack.
static VkImageDrmFormatModifierListCreateInfoEXT	mallocStack()	Deprecated.
static VkImageDrmFormatModifierListCreateInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkImageDrmFormatModifierListCreateInfoEXT.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageDrmFormatModifierListCreateInfoEXT	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	ndrmFormatModifierCount(long struct)	Unsafe version of drmFormatModifierCount().
static void	ndrmFormatModifierCount(long struct, int value)	Sets the specified value to the drmFormatModifierCount field of the specified struct.
static LongBuffer	npDrmFormatModifiers(long struct)	Unsafe version of pDrmFormatModifiers.
static void	npDrmFormatModifiers(long struct, LongBuffer value)	Unsafe version of pDrmFormatModifiers.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
LongBuffer	pDrmFormatModifiers()	a pointer to an array of Linux DRM format modifiers.
VkImageDrmFormatModifierListCreateInfoEXT	pDrmFormatModifiers(LongBuffer value)	Sets the address of the specified LongBuffer to the pDrmFormatModifiers() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkImageDrmFormatModifierListCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkImageDrmFormatModifierListCreateInfoEXT	set(int sType, long pNext, LongBuffer pDrmFormatModifiers)	Initializes this struct with the specified values.
VkImageDrmFormatModifierListCreateInfoEXT	set(VkImageDrmFormatModifierListCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkImageDrmFormatModifierListCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkImageDrmFormatModifierListCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_LIST_CREATE_INFO_EXT value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

DRMFORMATMODIFIERCOUNT

public static final int DRMFORMATMODIFIERCOUNT

The struct member offsets.

PDRMFORMATMODIFIERS

public static final int PDRMFORMATMODIFIERS

The struct member offsets.

Constructor Details

VkImageDrmFormatModifierListCreateInfoEXT

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkImageDrmFormatModifierListCreateInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

drmFormatModifierCount

public int drmFormatModifierCount()

the length of the pDrmFormatModifiers array.

pDrmFormatModifiers

public LongBuffer pDrmFormatModifiers()

a pointer to an array of Linux DRM format modifiers.

sType

public VkImageDrmFormatModifierListCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageDrmFormatModifierListCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_LIST_CREATE_INFO_EXT value to the sType() field.

pNext

public VkImageDrmFormatModifierListCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

pDrmFormatModifiers

public VkImageDrmFormatModifierListCreateInfoEXT pDrmFormatModifiers(LongBuffer value)

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

set

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

Initializes this struct with the specified values.

set

public VkImageDrmFormatModifierListCreateInfoEXT set(VkImageDrmFormatModifierListCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageDrmFormatModifierListCreateInfoEXT malloc()

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

calloc

public static VkImageDrmFormatModifierListCreateInfoEXT calloc()

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

create

public static VkImageDrmFormatModifierListCreateInfoEXT create()

Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated with BufferUtils.

create

public static VkImageDrmFormatModifierListCreateInfoEXT create(long address)

Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkImageDrmFormatModifierListCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer create(int capacity)

Returns a new VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageDrmFormatModifierListCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImageDrmFormatModifierListCreateInfoEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImageDrmFormatModifierListCreateInfoEXT callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkImageDrmFormatModifierListCreateInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageDrmFormatModifierListCreateInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkImageDrmFormatModifierListCreateInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkImageDrmFormatModifierListCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImageDrmFormatModifierListCreateInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkImageDrmFormatModifierListCreateInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

ndrmFormatModifierCount

public static int ndrmFormatModifierCount(long struct)

Unsafe version of drmFormatModifierCount().

npDrmFormatModifiers

public static LongBuffer npDrmFormatModifiers(long struct)

Unsafe version of pDrmFormatModifiers.

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

ndrmFormatModifierCount

public static void ndrmFormatModifierCount(long struct,
 int value)

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

npDrmFormatModifiers

public static void npDrmFormatModifiers(long struct,
 LongBuffer value)

Unsafe version of pDrmFormatModifiers.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate