Package org.lwjgl.vulkan
Class VkImagePlaneMemoryRequirementsInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImagePlaneMemoryRequirementsInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkImagePlaneMemoryRequirementsInfoKHR
public class VkImagePlaneMemoryRequirementsInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying image plane for memory requirements.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, for a two-plane imageplaneAspect
must beIMAGE_ASPECT_PLANE_0_BIT
orIMAGE_ASPECT_PLANE_1_BIT
, and for a three-plane imageplaneAspect
must beIMAGE_ASPECT_PLANE_0_BIT
,IMAGE_ASPECT_PLANE_1_BIT
orIMAGE_ASPECT_PLANE_2_BIT
). - 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
.)
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_IMAGE_PLANE_MEMORY_REQUIREMENTS_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 corresponding to the image plane to query.
Layout
struct VkImagePlaneMemoryRequirementsInfo { VkStructureType sType; void const * pNext; VkImageAspectFlagBits planeAspect; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkImagePlaneMemoryRequirementsInfo.Buffer
An array ofVkImagePlaneMemoryRequirementsInfo
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 VkImagePlaneMemoryRequirementsInfo(java.nio.ByteBuffer container)
Creates aVkImagePlaneMemoryRequirementsInfo
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 VkImagePlaneMemoryRequirementsInfo
calloc()
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated withmemCalloc
.static VkImagePlaneMemoryRequirementsInfo.Buffer
calloc(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated withmemCalloc
.static VkImagePlaneMemoryRequirementsInfo
callocStack()
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImagePlaneMemoryRequirementsInfo.Buffer
callocStack(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImagePlaneMemoryRequirementsInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImagePlaneMemoryRequirementsInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImagePlaneMemoryRequirementsInfo
create()
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated withBufferUtils
.static VkImagePlaneMemoryRequirementsInfo.Buffer
create(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated withBufferUtils
.static VkImagePlaneMemoryRequirementsInfo
create(long address)
Returns a newVkImagePlaneMemoryRequirementsInfo
instance for the specified memory address.static VkImagePlaneMemoryRequirementsInfo.Buffer
create(long address, int capacity)
Create aVkImagePlaneMemoryRequirementsInfo.Buffer
instance at the specified memory.static VkImagePlaneMemoryRequirementsInfo
createSafe(long address)
static VkImagePlaneMemoryRequirementsInfo.Buffer
createSafe(long address, int capacity)
static VkImagePlaneMemoryRequirementsInfo
malloc()
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated withmemAlloc
.static VkImagePlaneMemoryRequirementsInfo.Buffer
malloc(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated withmemAlloc
.static VkImagePlaneMemoryRequirementsInfo
mallocStack()
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated on the thread-localMemoryStack
.static VkImagePlaneMemoryRequirementsInfo.Buffer
mallocStack(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkImagePlaneMemoryRequirementsInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkImagePlaneMemoryRequirementsInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImagePlaneMemoryRequirementsInfo
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.VkImagePlaneMemoryRequirementsInfo
planeAspect(int value)
Sets the specified value to theplaneAspect
field.long
pNext()
Returns the value of thepNext
field.VkImagePlaneMemoryRequirementsInfo
pNext(long value)
Sets the specified value to thepNext
field.VkImagePlaneMemoryRequirementsInfo
set(int sType, long pNext, int planeAspect)
Initializes this struct with the specified values.VkImagePlaneMemoryRequirementsInfo
set(VkImagePlaneMemoryRequirementsInfo src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkImagePlaneMemoryRequirementsInfo
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkImagePlaneMemoryRequirementsInfo
public VkImagePlaneMemoryRequirementsInfo(java.nio.ByteBuffer container)
Creates aVkImagePlaneMemoryRequirementsInfo
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 VkImagePlaneMemoryRequirementsInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkImagePlaneMemoryRequirementsInfo pNext(long value)
Sets the specified value to thepNext
field.
-
planeAspect
public VkImagePlaneMemoryRequirementsInfo planeAspect(int value)
Sets the specified value to theplaneAspect
field.
-
set
public VkImagePlaneMemoryRequirementsInfo set(int sType, long pNext, int planeAspect)
Initializes this struct with the specified values.
-
set
public VkImagePlaneMemoryRequirementsInfo set(VkImagePlaneMemoryRequirementsInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkImagePlaneMemoryRequirementsInfo malloc()
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImagePlaneMemoryRequirementsInfo calloc()
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImagePlaneMemoryRequirementsInfo create()
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated withBufferUtils
.
-
create
public static VkImagePlaneMemoryRequirementsInfo create(long address)
Returns a newVkImagePlaneMemoryRequirementsInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkImagePlaneMemoryRequirementsInfo createSafe(long address)
-
malloc
public static VkImagePlaneMemoryRequirementsInfo.Buffer malloc(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImagePlaneMemoryRequirementsInfo.Buffer calloc(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImagePlaneMemoryRequirementsInfo.Buffer create(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImagePlaneMemoryRequirementsInfo.Buffer create(long address, int capacity)
Create aVkImagePlaneMemoryRequirementsInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkImagePlaneMemoryRequirementsInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkImagePlaneMemoryRequirementsInfo mallocStack()
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImagePlaneMemoryRequirementsInfo callocStack()
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImagePlaneMemoryRequirementsInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImagePlaneMemoryRequirementsInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImagePlaneMemoryRequirementsInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkImagePlaneMemoryRequirementsInfo.Buffer mallocStack(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImagePlaneMemoryRequirementsInfo.Buffer callocStack(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkImagePlaneMemoryRequirementsInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImagePlaneMemoryRequirementsInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkImagePlaneMemoryRequirementsInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImagePlaneMemoryRequirementsInfo.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
.
-
-