Package org.lwjgl.vulkan
Class VkBindImagePlaneMemoryInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkBindImagePlaneMemoryInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkBindImagePlaneMemoryInfoKHR
public class VkBindImagePlaneMemoryInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying how to bind an image plane to memory.Valid Usage
- If the image’s tiling is
IMAGE_TILING_LINEAR
orIMAGE_TILING_OPTIMAL
, thenplaneAspect
must be a single valid format plane for the image. (That is,planeAspect
must beIMAGE_ASPECT_PLANE_0_BIT
orIMAGE_ASPECT_PLANE_1_BIT
for “_2PLANE
” formats andplaneAspect
must beIMAGE_ASPECT_PLANE_0_BIT
,IMAGE_ASPECT_PLANE_1_BIT
, orIMAGE_ASPECT_PLANE_2_BIT
for “_3PLANE
” formats.) - If the image’s tiling is
IMAGE_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 thedrmFormatModifierPlaneCount
associated with the image’sformat
anddrmFormatModifier
.) - A single call to
BindImageMemory2
must bind all or none of the planes of an image (i.e. bindings to all planes of an image must be made in a singleBindImageMemory2
call), as separate bindings
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO
planeAspect
must be a validVkImageAspectFlagBits
value
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.planeAspect
– the aspect of the disjoint image plane to bind.
Layout
struct VkBindImagePlaneMemoryInfo { VkStructureType sType; void const * pNext; VkImageAspectFlagBits planeAspect; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkBindImagePlaneMemoryInfo.Buffer
An array ofVkBindImagePlaneMemoryInfo
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
PLANEASPECT
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkBindImagePlaneMemoryInfo(java.nio.ByteBuffer container)
Creates aVkBindImagePlaneMemoryInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkBindImagePlaneMemoryInfo
calloc()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated withmemCalloc
.static VkBindImagePlaneMemoryInfo.Buffer
calloc(int capacity)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated withmemCalloc
.static VkBindImagePlaneMemoryInfo
callocStack()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkBindImagePlaneMemoryInfo.Buffer
callocStack(int capacity)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkBindImagePlaneMemoryInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBindImagePlaneMemoryInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkBindImagePlaneMemoryInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBindImagePlaneMemoryInfo
create()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated withBufferUtils
.static VkBindImagePlaneMemoryInfo.Buffer
create(int capacity)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated withBufferUtils
.static VkBindImagePlaneMemoryInfo
create(long address)
Returns a newVkBindImagePlaneMemoryInfo
instance for the specified memory address.static VkBindImagePlaneMemoryInfo.Buffer
create(long address, int capacity)
Create aVkBindImagePlaneMemoryInfo.Buffer
instance at the specified memory.static VkBindImagePlaneMemoryInfo
createSafe(long address)
static VkBindImagePlaneMemoryInfo.Buffer
createSafe(long address, int capacity)
static VkBindImagePlaneMemoryInfo
malloc()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated withmemAlloc
.static VkBindImagePlaneMemoryInfo.Buffer
malloc(int capacity)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated withmemAlloc
.static VkBindImagePlaneMemoryInfo
mallocStack()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated on the thread-localMemoryStack
.static VkBindImagePlaneMemoryInfo.Buffer
mallocStack(int capacity)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkBindImagePlaneMemoryInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkBindImagePlaneMemoryInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkBindImagePlaneMemoryInfo
instance allocated on the specifiedMemoryStack
.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
planeAspect()
Returns the value of theplaneAspect
field.VkBindImagePlaneMemoryInfo
planeAspect(int value)
Sets the specified value to theplaneAspect
field.long
pNext()
Returns the value of thepNext
field.VkBindImagePlaneMemoryInfo
pNext(long value)
Sets the specified value to thepNext
field.VkBindImagePlaneMemoryInfo
set(int sType, long pNext, int planeAspect)
Initializes this struct with the specified values.VkBindImagePlaneMemoryInfo
set(VkBindImagePlaneMemoryInfo src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkBindImagePlaneMemoryInfo
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkBindImagePlaneMemoryInfo
public VkBindImagePlaneMemoryInfo(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
planeAspect
public int planeAspect()
Returns the value of theplaneAspect
field.
-
sType
public VkBindImagePlaneMemoryInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkBindImagePlaneMemoryInfo pNext(long value)
Sets the specified value to thepNext
field.
-
planeAspect
public VkBindImagePlaneMemoryInfo planeAspect(int value)
Sets the specified value to theplaneAspect
field.
-
set
public VkBindImagePlaneMemoryInfo set(int sType, long pNext, int planeAspect)
Initializes this struct with the specified values.
-
set
public VkBindImagePlaneMemoryInfo set(VkBindImagePlaneMemoryInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkBindImagePlaneMemoryInfo malloc()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkBindImagePlaneMemoryInfo calloc()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkBindImagePlaneMemoryInfo create()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated withBufferUtils
.
-
create
public static VkBindImagePlaneMemoryInfo create(long address)
Returns a newVkBindImagePlaneMemoryInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkBindImagePlaneMemoryInfo createSafe(long address)
-
malloc
public static VkBindImagePlaneMemoryInfo.Buffer malloc(int capacity)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkBindImagePlaneMemoryInfo.Buffer calloc(int capacity)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkBindImagePlaneMemoryInfo.Buffer create(int capacity)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkBindImagePlaneMemoryInfo.Buffer create(long address, int capacity)
Create aVkBindImagePlaneMemoryInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkBindImagePlaneMemoryInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkBindImagePlaneMemoryInfo mallocStack()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkBindImagePlaneMemoryInfo callocStack()
Returns a newVkBindImagePlaneMemoryInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkBindImagePlaneMemoryInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkBindImagePlaneMemoryInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkBindImagePlaneMemoryInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkBindImagePlaneMemoryInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkBindImagePlaneMemoryInfo.Buffer mallocStack(int capacity)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkBindImagePlaneMemoryInfo.Buffer callocStack(int capacity)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkBindImagePlaneMemoryInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkBindImagePlaneMemoryInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBindImagePlaneMemoryInfo.Buffer
instance allocated on the specifiedMemoryStack
and 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()
.
-
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
.
-
-