Package org.lwjgl.vulkan
Class VkBindImagePlaneMemoryInfo
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
- Direct Known Subclasses:
VkBindImagePlaneMemoryInfoKHR
public class VkBindImagePlaneMemoryInfo
extends Struct<VkBindImagePlaneMemoryInfo>
implements NativeResource
Structure specifying how to bind an image plane to memory.
Valid Usage
- If the image’s
tiling
isIMAGE_TILING_LINEAR
orIMAGE_TILING_OPTIMAL
, thenplaneAspect
must be a single valid multi-planar aspect mask bit - If the image’s
tiling
isIMAGE_TILING_DRM_FORMAT_MODIFIER_EXT
, thenplaneAspect
must be a single valid memory plane for the image (that is,aspectMask
must specify a plane index that is less than theVkDrmFormatModifierPropertiesEXT
::drmFormatModifierPlaneCount
associated with the image’sformat
andVkImageDrmFormatModifierPropertiesEXT
::drmFormatModifier
)
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO
planeAspect
must be a validVkImageAspectFlagBits
value
Layout
struct VkBindImagePlaneMemoryInfo {
VkStructureType sType()
;
void const * pNext()
;
VkImageAspectFlagBits planeAspect()
;
}
-
Nested Class Summary
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 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
ConstructorDescriptionVkBindImagePlaneMemoryInfo
(ByteBuffer container) Creates aVkBindImagePlaneMemoryInfo
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkBindImagePlaneMemoryInfo
calloc()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBindImagePlaneMemoryInfo
calloc
(MemoryStack stack) Returns a newVkBindImagePlaneMemoryInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBindImagePlaneMemoryInfo
Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.static VkBindImagePlaneMemoryInfo
callocStack
(MemoryStack stack) Deprecated.static VkBindImagePlaneMemoryInfo
create()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated withBufferUtils
.static VkBindImagePlaneMemoryInfo
create
(long address) Returns a newVkBindImagePlaneMemoryInfo
instance for the specified memory address.create
(long address, int capacity) Create aVkBindImagePlaneMemoryInfo.Buffer
instance at the specified memory.static VkBindImagePlaneMemoryInfo
createSafe
(long address) createSafe
(long address, int capacity) static VkBindImagePlaneMemoryInfo
malloc()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkBindImagePlaneMemoryInfo
malloc
(MemoryStack stack) Returns a newVkBindImagePlaneMemoryInfo
instance allocated on the specifiedMemoryStack
.static VkBindImagePlaneMemoryInfo
Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkBindImagePlaneMemoryInfo
mallocStack
(MemoryStack stack) Deprecated.static int
nplaneAspect
(long struct) Unsafe version ofplaneAspect()
.static void
nplaneAspect
(long struct, int value) Unsafe version ofplaneAspect
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.int
aVkImageAspectFlagBits
value specifying the aspect of the disjoint image plane to bind.planeAspect
(int value) Sets the specified value to theplaneAspect()
field.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.set
(int sType, long pNext, int planeAspect) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO
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. -
PLANEASPECT
public static final int PLANEASPECTThe struct member offsets.
-
-
Constructor Details
-
VkBindImagePlaneMemoryInfo
Creates aVkBindImagePlaneMemoryInfo
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<VkBindImagePlaneMemoryInfo>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
planeAspect
public int planeAspect()aVkImageAspectFlagBits
value specifying the aspect of the disjoint image plane to bind. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
planeAspect
Sets the specified value to theplaneAspect()
field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkBindImagePlaneMemoryInfo
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkBindImagePlaneMemoryInfo
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkBindImagePlaneMemoryInfo
instance allocated withBufferUtils
. -
create
Returns a newVkBindImagePlaneMemoryInfo
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkBindImagePlaneMemoryInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
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.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkBindImagePlaneMemoryInfo.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkBindImagePlaneMemoryInfo.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkBindImagePlaneMemoryInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkBindImagePlaneMemoryInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkBindImagePlaneMemoryInfo.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()
. -
nplaneAspect
public static int nplaneAspect(long struct) Unsafe version ofplaneAspect()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
. -
nplaneAspect
public static void nplaneAspect(long struct, int value) Unsafe version ofplaneAspect
.
-