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, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkPhysicalDeviceImageDrmFormatModifierInfoEXT
extends org.lwjgl.system.Struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>
implements org.lwjgl.system.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 is SHARING_MODE_CONCURRENT, then pQueueFamilyIndices must be a valid pointer to an array of queueFamilyIndexCount uint32_t values
• If sharingMode is SHARING_MODE_CONCURRENT, then queueFamilyIndexCount must be greater than 1
• If sharingMode is SHARING_MODE_CONCURRENT, each element of pQueueFamilyIndices must be unique and must be less than the pQueueFamilyPropertyCount returned by GetPhysicalDeviceQueueFamilyProperties2 for the physicalDevice that was used to create device

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_DRM_FORMAT_MODIFIER_INFO_EXT
• sharingMode must be a valid VkSharingMode value

Layout

 struct VkPhysicalDeviceImageDrmFormatModifierInfoEXT {
     VkStructureType sType();
     void const * pNext();
     uint64_t drmFormatModifier();
     VkSharingMode sharingMode();
     uint32_t queueFamilyIndexCount();
     uint32_t const * pQueueFamilyIndices();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer	An array of VkPhysicalDeviceImageDrmFormatModifierInfoEXT 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	DRMFORMATMODIFIER	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PQUEUEFAMILYINDICES	The struct member offsets.
static final int	QUEUEFAMILYINDEXCOUNT	The struct member offsets.
static final int	SHARINGMODE	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
VkPhysicalDeviceImageDrmFormatModifierInfoEXT(ByteBuffer container)	Creates a VkPhysicalDeviceImageDrmFormatModifierInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT	calloc()	Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT instance allocated with memCalloc.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT	callocStack()	Deprecated.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT	create()	Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT instance allocated with BufferUtils.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT	create(long address)	Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT instance for the specified memory address.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceImageDrmFormatModifierInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	drmFormatModifier()	the image’s Linux DRM format modifier, corresponding to VkImageDrmFormatModifierExplicitCreateInfoEXT::modifier or to VkImageDrmFormatModifierListCreateInfoEXT::pModifiers.
VkPhysicalDeviceImageDrmFormatModifierInfoEXT	drmFormatModifier(long value)	Sets the specified value to the drmFormatModifier() field.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT	malloc()	Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT instance allocated with memAlloc.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT instance allocated on the specified MemoryStack.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT	mallocStack()	Deprecated.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceImageDrmFormatModifierInfoEXT	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 long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable IntBuffer	npQueueFamilyIndices(long struct)	Unsafe version of pQueueFamilyIndices.
static void	npQueueFamilyIndices(long struct, @Nullable IntBuffer value)	Unsafe version of pQueueFamilyIndices.
static int	nqueueFamilyIndexCount(long struct)	Unsafe version of queueFamilyIndexCount().
static void	nqueueFamilyIndexCount(long struct, int value)	Sets the specified value to the queueFamilyIndexCount field of the specified struct.
static int	nsharingMode(long struct)	Unsafe version of sharingMode().
static void	nsharingMode(long struct, int value)	Unsafe version of sharingMode.
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.
VkPhysicalDeviceImageDrmFormatModifierInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
@Nullable IntBuffer	pQueueFamilyIndices()	a pointer to an array of queue families that will access the image.
VkPhysicalDeviceImageDrmFormatModifierInfoEXT	pQueueFamilyIndices(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pQueueFamilyIndices() field.
int	queueFamilyIndexCount()	the number of entries in the pQueueFamilyIndices array.
VkPhysicalDeviceImageDrmFormatModifierInfoEXT	queueFamilyIndexCount(int value)	Sets the specified value to the queueFamilyIndexCount() field.
VkPhysicalDeviceImageDrmFormatModifierInfoEXT	set(int sType, long pNext, long drmFormatModifier, int sharingMode, int queueFamilyIndexCount, @Nullable IntBuffer pQueueFamilyIndices)	Initializes this struct with the specified values.
VkPhysicalDeviceImageDrmFormatModifierInfoEXT	set(VkPhysicalDeviceImageDrmFormatModifierInfoEXT src)	Copies the specified struct data to this struct.
int	sharingMode()	specifies how the image will be accessed by multiple queue families.
VkPhysicalDeviceImageDrmFormatModifierInfoEXT	sharingMode(int value)	Sets the specified value to the sharingMode() field.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceImageDrmFormatModifierInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceImageDrmFormatModifierInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_DRM_FORMAT_MODIFIER_INFO_EXT value to the sType() field.

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.

DRMFORMATMODIFIER

public static final int DRMFORMATMODIFIER

The struct member offsets.

SHARINGMODE

public static final int SHARINGMODE

The struct member offsets.

QUEUEFAMILYINDEXCOUNT

public static final int QUEUEFAMILYINDEXCOUNT

The struct member offsets.

PQUEUEFAMILYINDICES

public static final int PQUEUEFAMILYINDICES

The struct member offsets.

Constructor Details

VkPhysicalDeviceImageDrmFormatModifierInfoEXT

public VkPhysicalDeviceImageDrmFormatModifierInfoEXT(ByteBuffer container)

Creates a VkPhysicalDeviceImageDrmFormatModifierInfoEXT 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<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>

sType

public int sType()

a VkStructureType 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 to VkImageDrmFormatModifierExplicitCreateInfoEXT::modifier or to VkImageDrmFormatModifierListCreateInfoEXT::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 the pQueueFamilyIndices array.

pQueueFamilyIndices

public @Nullable IntBuffer pQueueFamilyIndices()

a pointer to an array of queue families that will access the image. It is ignored if sharingMode is not SHARING_MODE_CONCURRENT.

sType

public VkPhysicalDeviceImageDrmFormatModifierInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceImageDrmFormatModifierInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_DRM_FORMAT_MODIFIER_INFO_EXT value to the sType() field.

pNext

public VkPhysicalDeviceImageDrmFormatModifierInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

drmFormatModifier

public VkPhysicalDeviceImageDrmFormatModifierInfoEXT drmFormatModifier(long value)

Sets the specified value to the drmFormatModifier() field.

sharingMode

public VkPhysicalDeviceImageDrmFormatModifierInfoEXT sharingMode(int value)

Sets the specified value to the sharingMode() field.

queueFamilyIndexCount

public VkPhysicalDeviceImageDrmFormatModifierInfoEXT queueFamilyIndexCount(int value)

Sets the specified value to the queueFamilyIndexCount() field.

pQueueFamilyIndices

public VkPhysicalDeviceImageDrmFormatModifierInfoEXT pQueueFamilyIndices(@Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the pQueueFamilyIndices() 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

public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT malloc()

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

calloc

public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT calloc()

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

create

public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT create()

Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT instance allocated with BufferUtils.

create

public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT create(long address)

Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceImageDrmFormatModifierInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer create(int capacity)

Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceImageDrmFormatModifierInfoEXT callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(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. Use malloc(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. Use calloc(int, MemoryStack) instead.

malloc

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

Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT instance allocated on the specified MemoryStack and 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 new VkPhysicalDeviceImageDrmFormatModifierInfoEXT.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkPhysicalDeviceImageDrmFormatModifierInfoEXT.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().

ndrmFormatModifier

public static long ndrmFormatModifier(long struct)

Unsafe version of drmFormatModifier().

nsharingMode

public static int nsharingMode(long struct)

Unsafe version of sharingMode().

nqueueFamilyIndexCount

public static int nqueueFamilyIndexCount(long struct)

Unsafe version of queueFamilyIndexCount().

npQueueFamilyIndices

public static @Nullable IntBuffer npQueueFamilyIndices(long struct)

Unsafe version of pQueueFamilyIndices.

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.

nsharingMode

public static void nsharingMode(long struct,
 int value)

Unsafe version of sharingMode.

nqueueFamilyIndexCount

public static void nqueueFamilyIndexCount(long struct,
 int value)

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

npQueueFamilyIndices

public static void npQueueFamilyIndices(long struct,
 @Nullable IntBuffer value)

Unsafe version of pQueueFamilyIndices.