java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkImageDrmFormatModifierExplicitCreateInfoEXT

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkImageDrmFormatModifierExplicitCreateInfoEXT
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Specify that an image be created with the provided DRM format modifier and explicit memory layout.
Description

The i^th member of pPlaneLayouts describes the layout of the image’s i^th memory plane (that is, VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT). In each element of pPlaneLayouts, the implementation must ignore size. The implementation calculates the size of each plane, which the application can query with GetImageSubresourceLayout.

When creating an image with VkImageDrmFormatModifierExplicitCreateInfoEXT, it is the application’s responsibility to satisfy all valid usage requirements. However, the implementation must validate that the provided pPlaneLayouts, when combined with the provided drmFormatModifier and other creation parameters in VkImageCreateInfo and its pNext chain, produce a valid image. (This validation is necessarily implementation-dependent and outside the scope of Vulkan, and therefore not described by valid usage requirements). If this validation fails, then CreateImage returns ERROR_INVALID_DRM_FORMAT_MODIFIER_PLANE_LAYOUT_EXT.

Valid Usage
- drmFormatModifier must be compatible with the parameters in VkImageCreateInfo and its pNext chain, as determined by querying VkPhysicalDeviceImageFormatInfo2 extended with VkPhysicalDeviceImageDrmFormatModifierInfoEXT
- drmFormatModifierPlaneCount must be equal to the VkDrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount associated with VkImageCreateInfo::format and drmFormatModifier, as found by querying VkDrmFormatModifierPropertiesListEXT
- For each element of pPlaneLayouts, size must be 0
- For each element of pPlaneLayouts, arrayPitch must be 0 if VkImageCreateInfo::arrayLayers is 1
- For each element of pPlaneLayouts, depthPitch must be 0 if VkImageCreateInfo::extent.depth is 1
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_EXPLICIT_CREATE_INFO_EXT
- If drmFormatModifierPlaneCount is not 0, pPlaneLayouts must be a valid pointer to an array of drmFormatModifierPlaneCount VkSubresourceLayout structures
See Also

VkSubresourceLayout

Layout
```
 struct VkImageDrmFormatModifierExplicitCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     uint64_t drmFormatModifier();
     uint32_t drmFormatModifierPlaneCount();
     VkSubresourceLayout const * pPlaneLayouts();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer
An array of VkImageDrmFormatModifierExplicitCreateInfoEXT structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`DRMFORMATMODIFIER DRMFORMATMODIFIERPLANECOUNT PNEXT PPLANELAYOUTS`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static 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
`VkImageDrmFormatModifierExplicitCreateInfoEXT(java.nio.ByteBuffer container)`	Creates a `VkImageDrmFormatModifierExplicitCreateInfoEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static VkImageDrmFormatModifierExplicitCreateInfoEXT`	`calloc()`	Returns a new `VkImageDrmFormatModifierExplicitCreateInfoEXT` instance allocated with `memCalloc`.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer`	`calloc(int capacity)`	Returns a new `VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer` instance allocated with `memCalloc`.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImageDrmFormatModifierExplicitCreateInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT`	`callocStack()`	Deprecated.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer`	`callocStack(int capacity)`	Deprecated.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT`	`create()`	Returns a new `VkImageDrmFormatModifierExplicitCreateInfoEXT` instance allocated with `BufferUtils`.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer`	`create(int capacity)`	Returns a new `VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer` instance allocated with `BufferUtils`.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT`	`create(long address)`	Returns a new `VkImageDrmFormatModifierExplicitCreateInfoEXT` instance for the specified memory address.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer`	`create(long address, int capacity)`	Create a `VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer` instance at the specified memory.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`long`	`drmFormatModifier()`	the Linux DRM format modifier with which the image will be created.
`VkImageDrmFormatModifierExplicitCreateInfoEXT`	`drmFormatModifier(long value)`	Sets the specified value to the `drmFormatModifier()` field.
`int`	`drmFormatModifierPlaneCount()`	the number of memory planes in the image (as reported by `VkDrmFormatModifierPropertiesEXT`) as well as the length of the `pPlaneLayouts` array.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT`	`malloc()`	Returns a new `VkImageDrmFormatModifierExplicitCreateInfoEXT` instance allocated with `memAlloc`.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer`	`malloc(int capacity)`	Returns a new `VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer` instance allocated with `memAlloc`.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImageDrmFormatModifierExplicitCreateInfoEXT` instance allocated on the specified `MemoryStack`.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT`	`mallocStack()`	Deprecated.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer`	`mallocStack(int capacity)`	Deprecated.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkImageDrmFormatModifierExplicitCreateInfoEXT`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static long`	`ndrmFormatModifier(long struct)`	Unsafe version of `drmFormatModifier()`.
`static void`	`ndrmFormatModifier(long struct, long value)`	Unsafe version of `drmFormatModifier`.
`static int`	`ndrmFormatModifierPlaneCount(long struct)`	Unsafe version of `drmFormatModifierPlaneCount()`.
`static void`	`ndrmFormatModifierPlaneCount(long struct, int value)`	Sets the specified value to the `drmFormatModifierPlaneCount` field of the specified `struct`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static VkSubresourceLayout.Buffer`	`npPlaneLayouts(long struct)`	Unsafe version of `pPlaneLayouts()`.
`static void`	`npPlaneLayouts(long struct, VkSubresourceLayout.Buffer value)`	Unsafe version of `pPlaneLayouts`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkImageDrmFormatModifierExplicitCreateInfoEXT`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkSubresourceLayout.Buffer`	`pPlaneLayouts()`	a pointer to an array of `VkSubresourceLayout` structures describing the image’s memory planes.
`VkImageDrmFormatModifierExplicitCreateInfoEXT`	`pPlaneLayouts(VkSubresourceLayout.Buffer value)`	Sets the address of the specified `VkSubresourceLayout.Buffer` to the `pPlaneLayouts()` field.
`VkImageDrmFormatModifierExplicitCreateInfoEXT`	`set(int sType, long pNext, long drmFormatModifier, VkSubresourceLayout.Buffer pPlaneLayouts)`	Initializes this struct with the specified values.
`VkImageDrmFormatModifierExplicitCreateInfoEXT`	`set(VkImageDrmFormatModifierExplicitCreateInfoEXT src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkImageDrmFormatModifierExplicitCreateInfoEXT`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkImageDrmFormatModifierExplicitCreateInfoEXT`	`sType$Default()`	Sets the `STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_EXPLICIT_CREATE_INFO_EXT` value to the `sType()` field.
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

Field Detail
- SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  The struct alignment in bytes.
- STYPE, PNEXT, DRMFORMATMODIFIER, DRMFORMATMODIFIERPLANECOUNT, PPLANELAYOUTS
  
  The struct member offsets.

Constructor Detail
- VkImageDrmFormatModifierExplicitCreateInfoEXT
```
public VkImageDrmFormatModifierExplicitCreateInfoEXT(java.nio.ByteBuffer container)
```
  Creates a VkImageDrmFormatModifierExplicitCreateInfoEXT 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

sizeof
```
public int sizeof()
```
Specified by:

sizeof in class org.lwjgl.system.Struct

sType
```
public int sType()
```
the type of this structure.

pNext
```
public long pNext()
```
NULL or a pointer to a structure extending this structure.

drmFormatModifier
```
public long drmFormatModifier()
```
the Linux DRM format modifier with which the image will be created.

drmFormatModifierPlaneCount
```
public int drmFormatModifierPlaneCount()
```
the number of memory planes in the image (as reported by VkDrmFormatModifierPropertiesEXT) as well as the length of the pPlaneLayouts array.

pPlaneLayouts
```
@Nullable
public VkSubresourceLayout.Buffer pPlaneLayouts()
```
a pointer to an array of VkSubresourceLayout structures describing the image’s memory planes.

sType

public VkImageDrmFormatModifierExplicitCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default
```
public VkImageDrmFormatModifierExplicitCreateInfoEXT sType$Default()
```
Sets the STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_EXPLICIT_CREATE_INFO_EXT value to the sType() field.

pNext

public VkImageDrmFormatModifierExplicitCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

drmFormatModifier

public VkImageDrmFormatModifierExplicitCreateInfoEXT drmFormatModifier(long value)

Sets the specified value to the drmFormatModifier() field.

pPlaneLayouts

public VkImageDrmFormatModifierExplicitCreateInfoEXT pPlaneLayouts(@Nullable
                                                                   VkSubresourceLayout.Buffer value)

Sets the address of the specified VkSubresourceLayout.Buffer to the pPlaneLayouts() field.

set

public VkImageDrmFormatModifierExplicitCreateInfoEXT set(int sType,
                                                         long pNext,
                                                         long drmFormatModifier,
                                                         @Nullable
                                                         VkSubresourceLayout.Buffer pPlaneLayouts)

Initializes this struct with the specified values.

set

public VkImageDrmFormatModifierExplicitCreateInfoEXT set(VkImageDrmFormatModifierExplicitCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:: src - the source struct
Returns:: this struct

malloc
```
public static VkImageDrmFormatModifierExplicitCreateInfoEXT malloc()
```
Returns a new VkImageDrmFormatModifierExplicitCreateInfoEXT instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static VkImageDrmFormatModifierExplicitCreateInfoEXT calloc()
```
Returns a new VkImageDrmFormatModifierExplicitCreateInfoEXT instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static VkImageDrmFormatModifierExplicitCreateInfoEXT create()
```
Returns a new VkImageDrmFormatModifierExplicitCreateInfoEXT instance allocated with BufferUtils.

create
```
public static VkImageDrmFormatModifierExplicitCreateInfoEXT create(long address)
```
Returns a new VkImageDrmFormatModifierExplicitCreateInfoEXT instance for the specified memory address.

createSafe

@Nullable
public static VkImageDrmFormatModifierExplicitCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer malloc(int capacity)
```
Returns a new VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer calloc(int capacity)
```
Returns a new VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer create(int capacity)
```
Returns a new VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImageDrmFormatModifierExplicitCreateInfoEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImageDrmFormatModifierExplicitCreateInfoEXT callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkImageDrmFormatModifierExplicitCreateInfoEXT.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 VkImageDrmFormatModifierExplicitCreateInfoEXT.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 VkImageDrmFormatModifierExplicitCreateInfoEXT malloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkImageDrmFormatModifierExplicitCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc
```
public static VkImageDrmFormatModifierExplicitCreateInfoEXT calloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkImageDrmFormatModifierExplicitCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:: stack - the stack from which to allocate; capacity - the buffer capacity

calloc
```
public static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer calloc(int capacity,
                                                                          org.lwjgl.system.MemoryStack stack)
```
Returns a new VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

ndrmFormatModifier

public static long ndrmFormatModifier(long struct)

Unsafe version of drmFormatModifier().

ndrmFormatModifierPlaneCount
```
public static int ndrmFormatModifierPlaneCount(long struct)
```
Unsafe version of drmFormatModifierPlaneCount().

npPlaneLayouts

@Nullable
public static VkSubresourceLayout.Buffer npPlaneLayouts(long struct)

Unsafe version of pPlaneLayouts().

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.

ndrmFormatModifier

public static void ndrmFormatModifier(long struct,
                                      long value)

Unsafe version of drmFormatModifier.

ndrmFormatModifierPlaneCount

public static void ndrmFormatModifierPlaneCount(long struct,
                                                int value)

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

npPlaneLayouts

public static void npPlaneLayouts(long struct,
                                  @Nullable
                                  VkSubresourceLayout.Buffer value)

Unsafe version of pPlaneLayouts.

validate
```
public static void validate(long struct)
```
Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate

Class VkImageDrmFormatModifierExplicitCreateInfoEXT

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

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

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

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

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, DRMFORMATMODIFIER, DRMFORMATMODIFIERPLANECOUNT, PPLANELAYOUTS

Constructor Detail

VkImageDrmFormatModifierExplicitCreateInfoEXT

Method Detail

sizeof

sType

pNext

drmFormatModifier

drmFormatModifierPlaneCount

pPlaneLayouts

sType

sType$Default

pNext

drmFormatModifier

pPlaneLayouts

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nsType

npNext

ndrmFormatModifier

ndrmFormatModifierPlaneCount

npPlaneLayouts

nsType

npNext

ndrmFormatModifier

ndrmFormatModifierPlaneCount

npPlaneLayouts

validate