Package org.lwjgl.vulkan
Class VkPhysicalDeviceImageDrmFormatModifierInfoEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPhysicalDeviceImageDrmFormatModifierInfoEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPhysicalDeviceImageDrmFormatModifierInfoEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying a DRM format modifier as image creation parameter.Description
If the
drmFormatModifieris incompatible with the parameters specified inVkPhysicalDeviceImageFormatInfo2and itspNextchain, thenGetPhysicalDeviceImageFormatProperties2returnsERROR_FORMAT_NOT_SUPPORTED. The implementation must support the query of anydrmFormatModifier, including unknown and invalid modifier values.Valid Usage
- If
sharingModeisSHARING_MODE_CONCURRENT, thenpQueueFamilyIndicesmust be a valid pointer to an array ofqueueFamilyIndexCountuint32_tvalues - If
sharingModeisSHARING_MODE_CONCURRENT, thenqueueFamilyIndexCountmust be greater than 1 - If
sharingModeisSHARING_MODE_CONCURRENT, each element ofpQueueFamilyIndicesmust be unique and must be less than thepQueueFamilyPropertyCountreturned byGetPhysicalDeviceQueueFamilyProperties2for thephysicalDevicethat was used to createdevice
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_DRM_FORMAT_MODIFIER_INFO_EXTsharingModemust be a validVkSharingModevalue
Layout
struct VkPhysicalDeviceImageDrmFormatModifierInfoEXT { VkStructureTypesType(); void const *pNext(); uint64_tdrmFormatModifier(); VkSharingModesharingMode(); uint32_tqueueFamilyIndexCount(); uint32_t const *pQueueFamilyIndices(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPhysicalDeviceImageDrmFormatModifierInfoEXT.BufferAn array ofVkPhysicalDeviceImageDrmFormatModifierInfoEXTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDRMFORMATMODIFIER
PNEXT
PQUEUEFAMILYINDICES
QUEUEFAMILYINDEXCOUNT
SHARINGMODEThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPhysicalDeviceImageDrmFormatModifierInfoEXT(java.nio.ByteBuffer container)Creates aVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkPhysicalDeviceImageDrmFormatModifierInfoEXTcalloc()Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance allocated withmemCalloc.static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffercalloc(int capacity)Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Bufferinstance allocated withmemCalloc.static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceImageDrmFormatModifierInfoEXTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceImageDrmFormatModifierInfoEXTcallocStack()Deprecated.static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.BuffercallocStack(int capacity)Deprecated.static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPhysicalDeviceImageDrmFormatModifierInfoEXTcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkPhysicalDeviceImageDrmFormatModifierInfoEXTcreate()Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance allocated withBufferUtils.static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffercreate(int capacity)Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Bufferinstance allocated withBufferUtils.static VkPhysicalDeviceImageDrmFormatModifierInfoEXTcreate(long address)Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance for the specified memory address.static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffercreate(long address, int capacity)Create aVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Bufferinstance at the specified memory.static VkPhysicalDeviceImageDrmFormatModifierInfoEXTcreateSafe(long address)static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.BuffercreateSafe(long address, int capacity)longdrmFormatModifier()the image’s Linux DRM format modifier, corresponding toVkImageDrmFormatModifierExplicitCreateInfoEXT::modifieror toVkImageDrmFormatModifierListCreateInfoEXT::pModifiers.VkPhysicalDeviceImageDrmFormatModifierInfoEXTdrmFormatModifier(long value)Sets the specified value to thedrmFormatModifier()field.static VkPhysicalDeviceImageDrmFormatModifierInfoEXTmalloc()Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance allocated withmemAlloc.static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffermalloc(int capacity)Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Bufferinstance allocated withmemAlloc.static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.static VkPhysicalDeviceImageDrmFormatModifierInfoEXTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance allocated on the specifiedMemoryStack.static VkPhysicalDeviceImageDrmFormatModifierInfoEXTmallocStack()Deprecated.static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.BuffermallocStack(int capacity)Deprecated.static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPhysicalDeviceImageDrmFormatModifierInfoEXTmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static longndrmFormatModifier(long struct)Unsafe version ofdrmFormatModifier().static voidndrmFormatModifier(long struct, long value)Unsafe version ofdrmFormatModifier.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static java.nio.IntBuffernpQueueFamilyIndices(long struct)Unsafe version ofpQueueFamilyIndices.static voidnpQueueFamilyIndices(long struct, java.nio.IntBuffer value)Unsafe version ofpQueueFamilyIndices.static intnqueueFamilyIndexCount(long struct)Unsafe version ofqueueFamilyIndexCount().static voidnqueueFamilyIndexCount(long struct, int value)Sets the specified value to thequeueFamilyIndexCountfield of the specifiedstruct.static intnsharingMode(long struct)Unsafe version ofsharingMode().static voidnsharingMode(long struct, int value)Unsafe version ofsharingMode.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.VkPhysicalDeviceImageDrmFormatModifierInfoEXTpNext(long value)Sets the specified value to thepNext()field.java.nio.IntBufferpQueueFamilyIndices()a pointer to an array of queue families that will access the image.VkPhysicalDeviceImageDrmFormatModifierInfoEXTpQueueFamilyIndices(java.nio.IntBuffer value)Sets the address of the specifiedIntBufferto thepQueueFamilyIndices()field.intqueueFamilyIndexCount()the number of entries in thepQueueFamilyIndicesarray.VkPhysicalDeviceImageDrmFormatModifierInfoEXTqueueFamilyIndexCount(int value)Sets the specified value to thequeueFamilyIndexCount()field.VkPhysicalDeviceImageDrmFormatModifierInfoEXTset(int sType, long pNext, long drmFormatModifier, int sharingMode, int queueFamilyIndexCount, java.nio.IntBuffer pQueueFamilyIndices)Initializes this struct with the specified values.VkPhysicalDeviceImageDrmFormatModifierInfoEXTset(VkPhysicalDeviceImageDrmFormatModifierInfoEXT src)Copies the specified struct data to this struct.intsharingMode()specifies how the image will be accessed by multiple queue families.VkPhysicalDeviceImageDrmFormatModifierInfoEXTsharingMode(int value)Sets the specified value to thesharingMode()field.intsizeof()intsType()the type of this structure.VkPhysicalDeviceImageDrmFormatModifierInfoEXTsType(int value)Sets the specified value to thesType()field.VkPhysicalDeviceImageDrmFormatModifierInfoEXTsType$Default()Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_DRM_FORMAT_MODIFIER_INFO_EXTvalue to thesType()field.
-
-
-
Constructor Detail
-
VkPhysicalDeviceImageDrmFormatModifierInfoEXT
public VkPhysicalDeviceImageDrmFormatModifierInfoEXT(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance 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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
drmFormatModifier
public long drmFormatModifier()
the image’s Linux DRM format modifier, corresponding toVkImageDrmFormatModifierExplicitCreateInfoEXT::modifieror toVkImageDrmFormatModifierListCreateInfoEXT::pModifiers.
-
sharingMode
public int sharingMode()
specifies how the image will be accessed by multiple queue families.
-
queueFamilyIndexCount
public int queueFamilyIndexCount()
the number of entries in thepQueueFamilyIndicesarray.
-
pQueueFamilyIndices
@Nullable public java.nio.IntBuffer pQueueFamilyIndices()
a pointer to an array of queue families that will access the image. It is ignored ifsharingModeis notSHARING_MODE_CONCURRENT.
-
sType
public VkPhysicalDeviceImageDrmFormatModifierInfoEXT sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkPhysicalDeviceImageDrmFormatModifierInfoEXT sType$Default()
Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_DRM_FORMAT_MODIFIER_INFO_EXTvalue to thesType()field.
-
pNext
public VkPhysicalDeviceImageDrmFormatModifierInfoEXT pNext(long value)
Sets the specified value to thepNext()field.
-
drmFormatModifier
public VkPhysicalDeviceImageDrmFormatModifierInfoEXT drmFormatModifier(long value)
Sets the specified value to thedrmFormatModifier()field.
-
sharingMode
public VkPhysicalDeviceImageDrmFormatModifierInfoEXT sharingMode(int value)
Sets the specified value to thesharingMode()field.
-
queueFamilyIndexCount
public VkPhysicalDeviceImageDrmFormatModifierInfoEXT queueFamilyIndexCount(int value)
Sets the specified value to thequeueFamilyIndexCount()field.
-
pQueueFamilyIndices
public VkPhysicalDeviceImageDrmFormatModifierInfoEXT pQueueFamilyIndices(@Nullable java.nio.IntBuffer value)
Sets the address of the specifiedIntBufferto thepQueueFamilyIndices()field.
-
set
public VkPhysicalDeviceImageDrmFormatModifierInfoEXT set(int sType, long pNext, long drmFormatModifier, int sharingMode, int queueFamilyIndexCount, @Nullable java.nio.IntBuffer pQueueFamilyIndices)
Initializes this struct with the specified values.
-
set
public VkPhysicalDeviceImageDrmFormatModifierInfoEXT set(VkPhysicalDeviceImageDrmFormatModifierInfoEXT src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT malloc()
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT calloc()
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT create()
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance allocated withBufferUtils.
-
create
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT create(long address)
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance for the specified memory address.
-
createSafe
@Nullable public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT createSafe(long address)
-
malloc
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer create(int capacity)
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer create(long address, int capacity)
Create aVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.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 VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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().
-
nsharingMode
public static int nsharingMode(long struct)
Unsafe version ofsharingMode().
-
nqueueFamilyIndexCount
public static int nqueueFamilyIndexCount(long struct)
Unsafe version ofqueueFamilyIndexCount().
-
npQueueFamilyIndices
@Nullable public static java.nio.IntBuffer npQueueFamilyIndices(long struct)
Unsafe version ofpQueueFamilyIndices.
-
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.
-
nsharingMode
public static void nsharingMode(long struct, int value)Unsafe version ofsharingMode.
-
nqueueFamilyIndexCount
public static void nqueueFamilyIndexCount(long struct, int value)Sets the specified value to thequeueFamilyIndexCountfield of the specifiedstruct.
-
npQueueFamilyIndices
public static void npQueueFamilyIndices(long struct, @Nullable java.nio.IntBuffer value)Unsafe version ofpQueueFamilyIndices.
-
-