Package org.lwjgl.vulkan
Class VkDeviceImageMemoryRequirements
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDeviceImageMemoryRequirements
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkDeviceImageMemoryRequirementsKHR
public class VkDeviceImageMemoryRequirements extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource(None).Valid Usage
- The
pCreateInfo::pNextchain must not contain aVkImageSwapchainCreateInfoKHRstructure - If
pCreateInfo::formatspecifies a multi-planar format andpCreateInfo::flagshasIMAGE_CREATE_DISJOINT_BITset thenplaneAspectmust not beIMAGE_ASPECT_NONE_KHR - If
pCreateInfo::flagshasIMAGE_CREATE_DISJOINT_BITset and if thepCreateInfo::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
pCreateInfo::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_DEVICE_IMAGE_MEMORY_REQUIREMENTSpNextmust beNULLpCreateInfomust be a valid pointer to a validVkImageCreateInfostructureplaneAspectmust be a validVkImageAspectFlagBitsvalue
See Also
VkImageCreateInfo,GetDeviceImageMemoryRequirements,GetDeviceImageMemoryRequirementsKHR,GetDeviceImageSparseMemoryRequirements,GetDeviceImageSparseMemoryRequirementsKHRLayout
struct VkDeviceImageMemoryRequirements { VkStructureTypesType(); void const *pNext();VkImageCreateInfoconst *pCreateInfo(); VkImageAspectFlagBitsplaneAspect(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkDeviceImageMemoryRequirements.BufferAn array ofVkDeviceImageMemoryRequirementsstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intPCREATEINFO
PLANEASPECT
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDeviceImageMemoryRequirements(java.nio.ByteBuffer container)Creates aVkDeviceImageMemoryRequirementsinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkDeviceImageMemoryRequirementscalloc()Returns a newVkDeviceImageMemoryRequirementsinstance allocated withmemCalloc.static VkDeviceImageMemoryRequirements.Buffercalloc(int capacity)Returns a newVkDeviceImageMemoryRequirements.Bufferinstance allocated withmemCalloc.static VkDeviceImageMemoryRequirements.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDeviceImageMemoryRequirements.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDeviceImageMemoryRequirementscalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDeviceImageMemoryRequirementsinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDeviceImageMemoryRequirementscreate()Returns a newVkDeviceImageMemoryRequirementsinstance allocated withBufferUtils.static VkDeviceImageMemoryRequirements.Buffercreate(int capacity)Returns a newVkDeviceImageMemoryRequirements.Bufferinstance allocated withBufferUtils.static VkDeviceImageMemoryRequirementscreate(long address)Returns a newVkDeviceImageMemoryRequirementsinstance for the specified memory address.static VkDeviceImageMemoryRequirements.Buffercreate(long address, int capacity)Create aVkDeviceImageMemoryRequirements.Bufferinstance at the specified memory.static VkDeviceImageMemoryRequirementscreateSafe(long address)static VkDeviceImageMemoryRequirements.BuffercreateSafe(long address, int capacity)static VkDeviceImageMemoryRequirementsmalloc()Returns a newVkDeviceImageMemoryRequirementsinstance allocated withmemAlloc.static VkDeviceImageMemoryRequirements.Buffermalloc(int capacity)Returns a newVkDeviceImageMemoryRequirements.Bufferinstance allocated withmemAlloc.static VkDeviceImageMemoryRequirements.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDeviceImageMemoryRequirements.Bufferinstance allocated on the specifiedMemoryStack.static VkDeviceImageMemoryRequirementsmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDeviceImageMemoryRequirementsinstance allocated on the specifiedMemoryStack.static VkImageCreateInfonpCreateInfo(long struct)Unsafe version ofpCreateInfo().static voidnpCreateInfo(long struct, VkImageCreateInfo value)Unsafe version ofpCreateInfo.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.VkImageCreateInfopCreateInfo()a pointer to aVkImageCreateInfostructure containing parameters affecting creation of the image to query.VkDeviceImageMemoryRequirementspCreateInfo(VkImageCreateInfo value)Sets the address of the specifiedVkImageCreateInfoto thepCreateInfo()field.intplaneAspect()aVkImageAspectFlagBitsvalue specifying the aspect corresponding to the image plane to query.VkDeviceImageMemoryRequirementsplaneAspect(int value)Sets the specified value to theplaneAspect()field.longpNext()NULLor a pointer to a structure extending this structure.VkDeviceImageMemoryRequirementspNext(long value)Sets the specified value to thepNext()field.VkDeviceImageMemoryRequirementsset(int sType, long pNext, VkImageCreateInfo pCreateInfo, int planeAspect)Initializes this struct with the specified values.VkDeviceImageMemoryRequirementsset(VkDeviceImageMemoryRequirements src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkDeviceImageMemoryRequirementssType(int value)Sets the specified value to thesType()field.VkDeviceImageMemoryRequirementssType$Default()Sets theSTRUCTURE_TYPE_DEVICE_IMAGE_MEMORY_REQUIREMENTSvalue to thesType()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
VkDeviceImageMemoryRequirements
public VkDeviceImageMemoryRequirements(java.nio.ByteBuffer container)
Creates aVkDeviceImageMemoryRequirementsinstance 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.
-
pCreateInfo
public VkImageCreateInfo pCreateInfo()
a pointer to aVkImageCreateInfostructure containing parameters affecting creation of the image to query.
-
planeAspect
public int planeAspect()
aVkImageAspectFlagBitsvalue specifying the aspect corresponding to the image plane to query. This parameter is ignored unlesspCreateInfo::tilingisIMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, orpCreateInfo::flagshasIMAGE_CREATE_DISJOINT_BITset.
-
sType
public VkDeviceImageMemoryRequirements sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkDeviceImageMemoryRequirements sType$Default()
Sets theSTRUCTURE_TYPE_DEVICE_IMAGE_MEMORY_REQUIREMENTSvalue to thesType()field.
-
pNext
public VkDeviceImageMemoryRequirements pNext(long value)
Sets the specified value to thepNext()field.
-
pCreateInfo
public VkDeviceImageMemoryRequirements pCreateInfo(VkImageCreateInfo value)
Sets the address of the specifiedVkImageCreateInfoto thepCreateInfo()field.
-
planeAspect
public VkDeviceImageMemoryRequirements planeAspect(int value)
Sets the specified value to theplaneAspect()field.
-
set
public VkDeviceImageMemoryRequirements set(int sType, long pNext, VkImageCreateInfo pCreateInfo, int planeAspect)
Initializes this struct with the specified values.
-
set
public VkDeviceImageMemoryRequirements set(VkDeviceImageMemoryRequirements src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkDeviceImageMemoryRequirements malloc()
Returns a newVkDeviceImageMemoryRequirementsinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkDeviceImageMemoryRequirements calloc()
Returns a newVkDeviceImageMemoryRequirementsinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkDeviceImageMemoryRequirements create()
Returns a newVkDeviceImageMemoryRequirementsinstance allocated withBufferUtils.
-
create
public static VkDeviceImageMemoryRequirements create(long address)
Returns a newVkDeviceImageMemoryRequirementsinstance for the specified memory address.
-
createSafe
@Nullable public static VkDeviceImageMemoryRequirements createSafe(long address)
-
malloc
public static VkDeviceImageMemoryRequirements.Buffer malloc(int capacity)
Returns a newVkDeviceImageMemoryRequirements.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkDeviceImageMemoryRequirements.Buffer calloc(int capacity)
Returns a newVkDeviceImageMemoryRequirements.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkDeviceImageMemoryRequirements.Buffer create(int capacity)
Returns a newVkDeviceImageMemoryRequirements.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkDeviceImageMemoryRequirements.Buffer create(long address, int capacity)
Create aVkDeviceImageMemoryRequirements.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkDeviceImageMemoryRequirements.Buffer createSafe(long address, int capacity)
-
malloc
public static VkDeviceImageMemoryRequirements malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceImageMemoryRequirementsinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkDeviceImageMemoryRequirements calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceImageMemoryRequirementsinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkDeviceImageMemoryRequirements.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceImageMemoryRequirements.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkDeviceImageMemoryRequirements.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceImageMemoryRequirements.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().
-
npCreateInfo
public static VkImageCreateInfo npCreateInfo(long struct)
Unsafe version ofpCreateInfo().
-
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.
-
npCreateInfo
public static void npCreateInfo(long struct, VkImageCreateInfo value)Unsafe version ofpCreateInfo.
-
nplaneAspect
public static void nplaneAspect(long struct, int value)Unsafe version ofplaneAspect.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-