Package org.lwjgl.vulkan
Class VkPhysicalDeviceImageDrmFormatModifierInfoEXT
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>
org.lwjgl.vulkan.VkPhysicalDeviceImageDrmFormatModifierInfoEXT
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkPhysicalDeviceImageDrmFormatModifierInfoEXT
extends Struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>
implements NativeResource
Structure specifying a DRM format modifier as image creation parameter.
Description
If the drmFormatModifier
is incompatible with the parameters specified in VkPhysicalDeviceImageFormatInfo2
and its pNext
chain, then GetPhysicalDeviceImageFormatProperties2
returns ERROR_FORMAT_NOT_SUPPORTED
. The implementation must support the query of any drmFormatModifier
, including unknown and invalid modifier values.
Valid Usage
- If
sharingMode
isSHARING_MODE_CONCURRENT
, thenpQueueFamilyIndices
must be a valid pointer to an array ofqueueFamilyIndexCount
uint32_t
values - If
sharingMode
isSHARING_MODE_CONCURRENT
, thenqueueFamilyIndexCount
must be greater than 1 - If
sharingMode
isSHARING_MODE_CONCURRENT
, each element ofpQueueFamilyIndices
must be unique and must be less than thepQueueFamilyPropertyCount
returned byGetPhysicalDeviceQueueFamilyProperties2
for thephysicalDevice
that was used to createdevice
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_DRM_FORMAT_MODIFIER_INFO_EXT
sharingMode
must be a validVkSharingMode
value
Layout
struct VkPhysicalDeviceImageDrmFormatModifierInfoEXT {
VkStructureType sType()
;
void const * pNext()
;
uint64_t drmFormatModifier()
;
VkSharingMode sharingMode()
;
uint32_t queueFamilyIndexCount()
;
uint32_t const * pQueueFamilyIndices()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkPhysicalDeviceImageDrmFormatModifierInfoEXT
structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionCreates aVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance for the specified memory address.create
(long address, int capacity) Create aVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) long
the image’s Linux DRM format modifier, corresponding toVkImageDrmFormatModifierExplicitCreateInfoEXT
::modifier
or toVkImageDrmFormatModifierListCreateInfoEXT
::pModifiers
.drmFormatModifier
(long value) Sets the specified value to thedrmFormatModifier()
field.malloc()
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.static long
ndrmFormatModifier
(long struct) Unsafe version ofdrmFormatModifier()
.static void
ndrmFormatModifier
(long struct, long value) Unsafe version ofdrmFormatModifier
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static IntBuffer
npQueueFamilyIndices
(long struct) Unsafe version ofpQueueFamilyIndices
.static void
npQueueFamilyIndices
(long struct, IntBuffer value) Unsafe version ofpQueueFamilyIndices
.static int
nqueueFamilyIndexCount
(long struct) Unsafe version ofqueueFamilyIndexCount()
.static void
nqueueFamilyIndexCount
(long struct, int value) Sets the specified value to thequeueFamilyIndexCount
field of the specifiedstruct
.static int
nsharingMode
(long struct) Unsafe version ofsharingMode()
.static void
nsharingMode
(long struct, int value) Unsafe version ofsharingMode
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.a pointer to an array of queue families that will access the image.pQueueFamilyIndices
(IntBuffer value) Sets the address of the specifiedIntBuffer
to thepQueueFamilyIndices()
field.int
the number of entries in thepQueueFamilyIndices
array.queueFamilyIndexCount
(int value) Sets the specified value to thequeueFamilyIndexCount()
field.set
(int sType, long pNext, long drmFormatModifier, int sharingMode, int queueFamilyIndexCount, IntBuffer pQueueFamilyIndices) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
specifies how the image will be accessed by multiple queue families.sharingMode
(int value) Sets the specified value to thesharingMode()
field.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_DRM_FORMAT_MODIFIER_INFO_EXT
value to thesType()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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. -
SHARINGMODE
public static final int SHARINGMODEThe struct member offsets. -
QUEUEFAMILYINDEXCOUNT
public static final int QUEUEFAMILYINDEXCOUNTThe struct member offsets. -
PQUEUEFAMILYINDICES
public static final int PQUEUEFAMILYINDICESThe struct member offsets.
-
-
Constructor Details
-
VkPhysicalDeviceImageDrmFormatModifierInfoEXT
Creates aVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance at the current position of the specifiedByteBuffer
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()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
drmFormatModifier
public long drmFormatModifier()the image’s Linux DRM format modifier, corresponding toVkImageDrmFormatModifierExplicitCreateInfoEXT
::modifier
or 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 thepQueueFamilyIndices
array. -
pQueueFamilyIndices
a pointer to an array of queue families that will access the image. It is ignored ifsharingMode
is notSHARING_MODE_CONCURRENT
. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_DRM_FORMAT_MODIFIER_INFO_EXT
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
drmFormatModifier
Sets the specified value to thedrmFormatModifier()
field. -
sharingMode
Sets the specified value to thesharingMode()
field. -
queueFamilyIndexCount
Sets the specified value to thequeueFamilyIndexCount()
field. -
pQueueFamilyIndices
Sets the address of the specifiedIntBuffer
to thepQueueFamilyIndices()
field. -
set
public VkPhysicalDeviceImageDrmFormatModifierInfoEXT set(int sType, long pNext, long drmFormatModifier, int sharingMode, int queueFamilyIndexCount, @Nullable 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
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance allocated withBufferUtils
. -
create
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer create(long address, int capacity) Create aVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer
instance 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.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 VkPhysicalDeviceImageDrmFormatModifierInfoEXT mallocStack(MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
@Deprecated public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT callocStack(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, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer malloc(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer calloc(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and 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()
. -
nsharingMode
public static int nsharingMode(long struct) Unsafe version ofsharingMode()
. -
nqueueFamilyIndexCount
public static int nqueueFamilyIndexCount(long struct) Unsafe version ofqueueFamilyIndexCount()
. -
npQueueFamilyIndices
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 thequeueFamilyIndexCount
field of the specifiedstruct
. -
npQueueFamilyIndices
Unsafe version ofpQueueFamilyIndices
.
-