Class VkImageDrmFormatModifierExplicitCreateInfoEXT
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
The ith member of pPlaneLayouts describes the layout of the image’s ith 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
drmFormatModifiermust be compatible with the parameters inVkImageCreateInfoand itspNextchain, as determined by queryingVkPhysicalDeviceImageFormatInfo2extended withVkPhysicalDeviceImageDrmFormatModifierInfoEXTdrmFormatModifierPlaneCountmust be equal to theVkDrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCountassociated withVkImageCreateInfo::formatanddrmFormatModifier, as found by queryingVkDrmFormatModifierPropertiesListEXT- For each element of
pPlaneLayouts,sizemust be 0 - For each element of
pPlaneLayouts,arrayPitchmust be 0 ifVkImageCreateInfo::arrayLayersis 1 - For each element of
pPlaneLayouts,depthPitchmust be 0 ifVkImageCreateInfo::extent.depthis 1
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_EXPLICIT_CREATE_INFO_EXTpPlaneLayoutsmust be a valid pointer to an array ofdrmFormatModifierPlaneCountVkSubresourceLayoutstructuresdrmFormatModifierPlaneCountmust be greater than 0
See Also
Layout
struct VkImageDrmFormatModifierExplicitCreateInfoEXT {
VkStructureType sType();
void const * pNext();
uint64_t drmFormatModifier();
uint32_t drmFormatModifierPlaneCount();
VkSubresourceLayout const * pPlaneLayouts();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkImageDrmFormatModifierExplicitCreateInfoEXTstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionCreates aVkImageDrmFormatModifierExplicitCreateInfoEXTinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXTinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXT.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXTinstance allocated withBufferUtils.create(int capacity) Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXT.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXTinstance for the specified memory address.create(long address, int capacity) Create aVkImageDrmFormatModifierExplicitCreateInfoEXT.Bufferinstance at the specified memory.static @Nullable VkImageDrmFormatModifierExplicitCreateInfoEXTcreateSafe(long address) static @Nullable VkImageDrmFormatModifierExplicitCreateInfoEXT.BuffercreateSafe(long address, int capacity) longthe Linux DRM format modifier with which the image will be created.drmFormatModifier(long value) Sets the specified value to thedrmFormatModifier()field.intthe number of memory planes in the image (as reported byVkDrmFormatModifierPropertiesEXT) as well as the length of thepPlaneLayoutsarray.malloc()Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXTinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXT.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXTinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static longndrmFormatModifier(long struct) Unsafe version ofdrmFormatModifier().static voidndrmFormatModifier(long struct, long value) Unsafe version ofdrmFormatModifier.static intndrmFormatModifierPlaneCount(long struct) Unsafe version ofdrmFormatModifierPlaneCount().static voidndrmFormatModifierPlaneCount(long struct, int value) Sets the specified value to thedrmFormatModifierPlaneCountfield of the specifiedstruct.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static VkSubresourceLayout.BuffernpPlaneLayouts(long struct) Unsafe version ofpPlaneLayouts().static voidnpPlaneLayouts(long struct, VkSubresourceLayout.Buffer value) Unsafe version ofpPlaneLayouts.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.a pointer to an array ofVkSubresourceLayoutstructures describing the image’s memory planes.Sets the address of the specifiedVkSubresourceLayout.Bufferto thepPlaneLayouts()field.set(int sType, long pNext, long drmFormatModifier, VkSubresourceLayout.Buffer pPlaneLayouts) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_EXPLICIT_CREATE_INFO_EXTvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
DRMFORMATMODIFIER
public static final int DRMFORMATMODIFIERThe struct member offsets. -
DRMFORMATMODIFIERPLANECOUNT
public static final int DRMFORMATMODIFIERPLANECOUNTThe struct member offsets. -
PPLANELAYOUTS
public static final int PPLANELAYOUTSThe struct member offsets.
-
-
Constructor Details
-
VkImageDrmFormatModifierExplicitCreateInfoEXT
Creates aVkImageDrmFormatModifierExplicitCreateInfoEXTinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkImageDrmFormatModifierExplicitCreateInfoEXT>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor 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 byVkDrmFormatModifierPropertiesEXT) as well as the length of thepPlaneLayoutsarray. -
pPlaneLayouts
a pointer to an array ofVkSubresourceLayoutstructures describing the image’s memory planes. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_EXPLICIT_CREATE_INFO_EXTvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
drmFormatModifier
Sets the specified value to thedrmFormatModifier()field. -
pPlaneLayouts
public VkImageDrmFormatModifierExplicitCreateInfoEXT pPlaneLayouts(VkSubresourceLayout.Buffer value) Sets the address of the specifiedVkSubresourceLayout.Bufferto thepPlaneLayouts()field. -
set
public VkImageDrmFormatModifierExplicitCreateInfoEXT set(int sType, long pNext, long drmFormatModifier, 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
Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXTinstance allocated withBufferUtils. -
create
Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXTinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer create(long address, int capacity) Create aVkImageDrmFormatModifierExplicitCreateInfoEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkImageDrmFormatModifierExplicitCreateInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkImageDrmFormatModifierExplicitCreateInfoEXT callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer mallocStack(int capacity) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer callocStack(int capacity) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(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. Usemalloc(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. Usecalloc(int, MemoryStack)instead. -
malloc
public static VkImageDrmFormatModifierExplicitCreateInfoEXT malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkImageDrmFormatModifierExplicitCreateInfoEXT calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXTinstance allocated on the specifiedMemoryStackand 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 newVkImageDrmFormatModifierExplicitCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkImageDrmFormatModifierExplicitCreateInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageDrmFormatModifierExplicitCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
ndrmFormatModifier
public static long ndrmFormatModifier(long struct) Unsafe version ofdrmFormatModifier(). -
ndrmFormatModifierPlaneCount
public static int ndrmFormatModifierPlaneCount(long struct) Unsafe version ofdrmFormatModifierPlaneCount(). -
npPlaneLayouts
Unsafe version ofpPlaneLayouts(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
ndrmFormatModifier
public static void ndrmFormatModifier(long struct, long value) Unsafe version ofdrmFormatModifier. -
ndrmFormatModifierPlaneCount
public static void ndrmFormatModifierPlaneCount(long struct, int value) Sets the specified value to thedrmFormatModifierPlaneCountfield of the specifiedstruct. -
npPlaneLayouts
Unsafe version ofpPlaneLayouts. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-