Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageDrmFormatModifierPropertiesEXT

extends Struct<VkImageDrmFormatModifierPropertiesEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Properties of an image’s Linux DRM format modifier.
Description

If the image was created with VkImageDrmFormatModifierListCreateInfoEXT, then the returned drmFormatModifier must belong to the list of modifiers provided at time of image creation in VkImageDrmFormatModifierListCreateInfoEXT::pDrmFormatModifiers. If the image was created with VkImageDrmFormatModifierExplicitCreateInfoEXT, then the returned drmFormatModifier must be the modifier provided at time of image creation in VkImageDrmFormatModifierExplicitCreateInfoEXT::drmFormatModifier.

Valid Usage (Implicit)
See Also

GetImageDrmFormatModifierPropertiesEXT

Layout


struct VkImageDrmFormatModifierPropertiesEXT {
    VkStructureType sType;
    void * pNext;
    uint64_t drmFormatModifier;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkImageDrmFormatModifierPropertiesEXT.Buffer

An array of VkImageDrmFormatModifierPropertiesEXT structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DRMFORMATMODIFIER

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkImageDrmFormatModifierPropertiesEXT(long address, ByteBuffer container)

public
VkImageDrmFormatModifierPropertiesEXT(ByteBuffer container)

Creates a VkImageDrmFormatModifierPropertiesEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkImageDrmFormatModifierPropertiesEXT
calloc()

Returns a new VkImageDrmFormatModifierPropertiesEXT instance allocated with memCalloc.

public static VkImageDrmFormatModifierPropertiesEXT.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkImageDrmFormatModifierPropertiesEXT.Buffer instance allocated with memCalloc.

public static VkImageDrmFormatModifierPropertiesEXT
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkImageDrmFormatModifierPropertiesEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkImageDrmFormatModifierPropertiesEXT.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkImageDrmFormatModifierPropertiesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkImageDrmFormatModifierPropertiesEXT
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageDrmFormatModifierPropertiesEXT
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageDrmFormatModifierPropertiesEXT.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageDrmFormatModifierPropertiesEXT.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkImageDrmFormatModifierPropertiesEXT
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkImageDrmFormatModifierPropertiesEXT
create()

Returns a new VkImageDrmFormatModifierPropertiesEXT instance allocated with BufferUtils.

public static VkImageDrmFormatModifierPropertiesEXT
create(long address)

Returns a new VkImageDrmFormatModifierPropertiesEXT instance for the specified memory address.

public static VkImageDrmFormatModifierPropertiesEXT.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkImageDrmFormatModifierPropertiesEXT.Buffer instance allocated with BufferUtils.

public static VkImageDrmFormatModifierPropertiesEXT.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkImageDrmFormatModifierPropertiesEXT.Buffer instance at the specified memory.

public static VkImageDrmFormatModifierPropertiesEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkImageDrmFormatModifierPropertiesEXT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public long
drmFormatModifier()

returns the image’s Linux DRM format modifier.

public static VkImageDrmFormatModifierPropertiesEXT
malloc()

Returns a new VkImageDrmFormatModifierPropertiesEXT instance allocated with memAlloc.

public static VkImageDrmFormatModifierPropertiesEXT.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkImageDrmFormatModifierPropertiesEXT.Buffer instance allocated with memAlloc.

public static VkImageDrmFormatModifierPropertiesEXT
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkImageDrmFormatModifierPropertiesEXT instance allocated on the specified MemoryStack.

public static VkImageDrmFormatModifierPropertiesEXT.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkImageDrmFormatModifierPropertiesEXT
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageDrmFormatModifierPropertiesEXT
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageDrmFormatModifierPropertiesEXT.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageDrmFormatModifierPropertiesEXT.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
ndrmFormatModifier(long struct)

Unsafe version of drmFormatModifier.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImageDrmFormatModifierPropertiesEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkImageDrmFormatModifierPropertiesEXT
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkImageDrmFormatModifierPropertiesEXT

Returns:

this struct
set(VkImageDrmFormatModifierPropertiesEXT
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkImageDrmFormatModifierPropertiesEXT
sType(int value)

Sets the specified value to the sType field.

public VkImageDrmFormatModifierPropertiesEXT
sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT value to the sType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DRMFORMATMODIFIERback to summary
public static final int DRMFORMATMODIFIER

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkImageDrmFormatModifierPropertiesEXTback to summary
protected VkImageDrmFormatModifierPropertiesEXT(long address, ByteBuffer container)
VkImageDrmFormatModifierPropertiesEXTback to summary
public VkImageDrmFormatModifierPropertiesEXT(ByteBuffer container)

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

callocback to summary
public static VkImageDrmFormatModifierPropertiesEXT calloc()

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

callocback to summary
public static VkImageDrmFormatModifierPropertiesEXT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageDrmFormatModifierPropertiesEXT calloc(MemoryStack stack)

Returns a new VkImageDrmFormatModifierPropertiesEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkImageDrmFormatModifierPropertiesEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkImageDrmFormatModifierPropertiesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkImageDrmFormatModifierPropertiesEXT callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkImageDrmFormatModifierPropertiesEXT callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkImageDrmFormatModifierPropertiesEXT.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkImageDrmFormatModifierPropertiesEXT.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkImageDrmFormatModifierPropertiesEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkImageDrmFormatModifierPropertiesEXT create()

Returns a new VkImageDrmFormatModifierPropertiesEXT instance allocated with BufferUtils.

createback to summary
public static VkImageDrmFormatModifierPropertiesEXT create(long address)

Returns a new VkImageDrmFormatModifierPropertiesEXT instance for the specified memory address.

createback to summary
public static VkImageDrmFormatModifierPropertiesEXT.Buffer create(int capacity)

Returns a new VkImageDrmFormatModifierPropertiesEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkImageDrmFormatModifierPropertiesEXT.Buffer create(long address, int capacity)

Create a VkImageDrmFormatModifierPropertiesEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageDrmFormatModifierPropertiesEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkImageDrmFormatModifierPropertiesEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
drmFormatModifierback to summary
public long drmFormatModifier()

returns the image’s Linux DRM format modifier.

Annotations
@NativeType:uint64_t
mallocback to summary
public static VkImageDrmFormatModifierPropertiesEXT malloc()

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

mallocback to summary
public static VkImageDrmFormatModifierPropertiesEXT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageDrmFormatModifierPropertiesEXT malloc(MemoryStack stack)

Returns a new VkImageDrmFormatModifierPropertiesEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkImageDrmFormatModifierPropertiesEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkImageDrmFormatModifierPropertiesEXT mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkImageDrmFormatModifierPropertiesEXT mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkImageDrmFormatModifierPropertiesEXT.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkImageDrmFormatModifierPropertiesEXT.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
ndrmFormatModifierback to summary
public static long ndrmFormatModifier(long struct)

Unsafe version of drmFormatModifier.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkImageDrmFormatModifierPropertiesEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkImageDrmFormatModifierPropertiesEXT set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkImageDrmFormatModifierPropertiesEXT set(VkImageDrmFormatModifierPropertiesEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkImageDrmFormatModifierPropertiesEXT

the source struct

Returns:VkImageDrmFormatModifierPropertiesEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImageDrmFormatModifierPropertiesEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkImageDrmFormatModifierPropertiesEXT sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkImageDrmFormatModifierPropertiesEXT.Buffer

extends StructBuffer<VkImageDrmFormatModifierPropertiesEXT, VkImageDrmFormatModifierPropertiesEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkImageDrmFormatModifierPropertiesEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkImageDrmFormatModifierPropertiesEXT
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImageDrmFormatModifierPropertiesEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the VkImageDrmFormatModifierPropertiesEXT#drmFormatModifier field.
drmFormatModifier()

protected VkImageDrmFormatModifierPropertiesEXT
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public long

Returns:

the value of the VkImageDrmFormatModifierPropertiesEXT#pNext field.
pNext()

public VkImageDrmFormatModifierPropertiesEXT.Buffer
pNext(long value)

Sets the specified value to the VkImageDrmFormatModifierPropertiesEXT#pNext field.

protected VkImageDrmFormatModifierPropertiesEXT.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkImageDrmFormatModifierPropertiesEXT#sType field.
sType()

public VkImageDrmFormatModifierPropertiesEXT.Buffer
sType(int value)

Sets the specified value to the VkImageDrmFormatModifierPropertiesEXT#sType field.

public VkImageDrmFormatModifierPropertiesEXT.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT value to the VkImageDrmFormatModifierPropertiesEXT#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageDrmFormatModifierPropertiesEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkImageDrmFormatModifierPropertiesEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkImageDrmFormatModifierPropertiesEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

drmFormatModifierback to summary
public long drmFormatModifier()
Returns:long

the value of the VkImageDrmFormatModifierPropertiesEXT#drmFormatModifier field.

Annotations
@NativeType:uint64_t
getElementFactoryback to summary
protected VkImageDrmFormatModifierPropertiesEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkImageDrmFormatModifierPropertiesEXT#pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkImageDrmFormatModifierPropertiesEXT.Buffer pNext(long value)

Sets the specified value to the VkImageDrmFormatModifierPropertiesEXT#pNext field.

selfback to summary
protected VkImageDrmFormatModifierPropertiesEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkImageDrmFormatModifierPropertiesEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImageDrmFormatModifierPropertiesEXT.Buffer sType(int value)

Sets the specified value to the VkImageDrmFormatModifierPropertiesEXT#sType field.

sType$Defaultback to summary
public VkImageDrmFormatModifierPropertiesEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT value to the VkImageDrmFormatModifierPropertiesEXT#sType field.