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.NativeResourceStructure specifying image plane for memory requirements.Valid Usage
- If the image’s
tilingisIMAGE_TILING_LINEARorIMAGE_TILING_OPTIMAL, thenplaneAspectmust be a single valid format plane for the image (that is, for a two-plane imageplaneAspectmust beIMAGE_ASPECT_PLANE_0_BITorIMAGE_ASPECT_PLANE_1_BIT, and for a three-plane imageplaneAspectmust beIMAGE_ASPECT_PLANE_0_BIT,IMAGE_ASPECT_PLANE_1_BITorIMAGE_ASPECT_PLANE_2_BIT) - If the image’s
tilingisIMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, thenplaneAspectmust be a single valid memory plane for the image (that is,aspectMaskmust specify a plane index that is less than theVkDrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCountassociated with the image’sformatandVkImageDrmFormatModifierPropertiesEXT::drmFormatModifier)
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMAGE_PLANE_MEMORY_REQUIREMENTS_INFOplaneAspectmust be a validVkImageAspectFlagBitsvalue
Layout
struct VkImagePlaneMemoryRequirementsInfo { VkStructureTypesType(); void const *pNext(); VkImageAspectFlagBitsplaneAspect(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkImagePlaneMemoryRequirementsInfo.BufferAn array ofVkImagePlaneMemoryRequirementsInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intPLANEASPECT
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkImagePlaneMemoryRequirementsInfo(java.nio.ByteBuffer container)Creates aVkImagePlaneMemoryRequirementsInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkImagePlaneMemoryRequirementsInfocalloc()Returns a newVkImagePlaneMemoryRequirementsInfoinstance allocated withmemCalloc.static VkImagePlaneMemoryRequirementsInfo.Buffercalloc(int capacity)Returns a newVkImagePlaneMemoryRequirementsInfo.Bufferinstance allocated withmemCalloc.static VkImagePlaneMemoryRequirementsInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImagePlaneMemoryRequirementsInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImagePlaneMemoryRequirementsInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkImagePlaneMemoryRequirementsInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImagePlaneMemoryRequirementsInfocallocStack()Deprecated.static VkImagePlaneMemoryRequirementsInfo.BuffercallocStack(int capacity)Deprecated.static VkImagePlaneMemoryRequirementsInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkImagePlaneMemoryRequirementsInfocallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkImagePlaneMemoryRequirementsInfocreate()Returns a newVkImagePlaneMemoryRequirementsInfoinstance allocated withBufferUtils.static VkImagePlaneMemoryRequirementsInfo.Buffercreate(int capacity)Returns a newVkImagePlaneMemoryRequirementsInfo.Bufferinstance allocated withBufferUtils.static VkImagePlaneMemoryRequirementsInfocreate(long address)Returns a newVkImagePlaneMemoryRequirementsInfoinstance for the specified memory address.static VkImagePlaneMemoryRequirementsInfo.Buffercreate(long address, int capacity)Create aVkImagePlaneMemoryRequirementsInfo.Bufferinstance at the specified memory.static VkImagePlaneMemoryRequirementsInfocreateSafe(long address)static VkImagePlaneMemoryRequirementsInfo.BuffercreateSafe(long address, int capacity)static VkImagePlaneMemoryRequirementsInfomalloc()Returns a newVkImagePlaneMemoryRequirementsInfoinstance allocated withmemAlloc.static VkImagePlaneMemoryRequirementsInfo.Buffermalloc(int capacity)Returns a newVkImagePlaneMemoryRequirementsInfo.Bufferinstance allocated withmemAlloc.static VkImagePlaneMemoryRequirementsInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImagePlaneMemoryRequirementsInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkImagePlaneMemoryRequirementsInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkImagePlaneMemoryRequirementsInfoinstance allocated on the specifiedMemoryStack.static VkImagePlaneMemoryRequirementsInfomallocStack()Deprecated.static VkImagePlaneMemoryRequirementsInfo.BuffermallocStack(int capacity)Deprecated.static VkImagePlaneMemoryRequirementsInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkImagePlaneMemoryRequirementsInfomallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static intnplaneAspect(long struct)Unsafe version ofplaneAspect().static voidnplaneAspect(long struct, int value)Unsafe version ofplaneAspect.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.intplaneAspect()aVkImageAspectFlagBitsvalue specifying the aspect corresponding to the image plane to query.VkImagePlaneMemoryRequirementsInfoplaneAspect(int value)Sets the specified value to theplaneAspect()field.longpNext()NULLor a pointer to a structure extending this structure.VkImagePlaneMemoryRequirementsInfopNext(long value)Sets the specified value to thepNext()field.VkImagePlaneMemoryRequirementsInfoset(int sType, long pNext, int planeAspect)Initializes this struct with the specified values.VkImagePlaneMemoryRequirementsInfoset(VkImagePlaneMemoryRequirementsInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkImagePlaneMemoryRequirementsInfosType(int value)Sets the specified value to thesType()field.VkImagePlaneMemoryRequirementsInfosType$Default()Sets theSTRUCTURE_TYPE_IMAGE_PLANE_MEMORY_REQUIREMENTS_INFOvalue to thesType()field.
-
-
-
Constructor Detail
-
VkImagePlaneMemoryRequirementsInfo
public VkImagePlaneMemoryRequirementsInfo(java.nio.ByteBuffer container)
Creates aVkImagePlaneMemoryRequirementsInfoinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
planeAspect
public int planeAspect()
aVkImageAspectFlagBitsvalue specifying the aspect corresponding to the image plane to query.
-
sType
public VkImagePlaneMemoryRequirementsInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkImagePlaneMemoryRequirementsInfo sType$Default()
Sets theSTRUCTURE_TYPE_IMAGE_PLANE_MEMORY_REQUIREMENTS_INFOvalue 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 newVkImagePlaneMemoryRequirementsInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkImagePlaneMemoryRequirementsInfo calloc()
Returns a newVkImagePlaneMemoryRequirementsInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkImagePlaneMemoryRequirementsInfo create()
Returns a newVkImagePlaneMemoryRequirementsInfoinstance allocated withBufferUtils.
-
create
public static VkImagePlaneMemoryRequirementsInfo create(long address)
Returns a newVkImagePlaneMemoryRequirementsInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkImagePlaneMemoryRequirementsInfo createSafe(long address)
-
malloc
public static VkImagePlaneMemoryRequirementsInfo.Buffer malloc(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkImagePlaneMemoryRequirementsInfo.Buffer calloc(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkImagePlaneMemoryRequirementsInfo.Buffer create(int capacity)
Returns a newVkImagePlaneMemoryRequirementsInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkImagePlaneMemoryRequirementsInfo.Buffer create(long address, int capacity)
Create aVkImagePlaneMemoryRequirementsInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkImagePlaneMemoryRequirementsInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkImagePlaneMemoryRequirementsInfo mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkImagePlaneMemoryRequirementsInfo callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkImagePlaneMemoryRequirementsInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkImagePlaneMemoryRequirementsInfo callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkImagePlaneMemoryRequirementsInfo.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkImagePlaneMemoryRequirementsInfo.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkImagePlaneMemoryRequirementsInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkImagePlaneMemoryRequirementsInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkImagePlaneMemoryRequirementsInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkImagePlaneMemoryRequirementsInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkImagePlaneMemoryRequirementsInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkImagePlaneMemoryRequirementsInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkImagePlaneMemoryRequirementsInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImagePlaneMemoryRequirementsInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkImagePlaneMemoryRequirementsInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImagePlaneMemoryRequirementsInfo.Bufferinstance allocated on the specifiedMemoryStackand 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.
-
-