Class VkImageAlignmentControlCreateInfoMESA
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
If maximumRequestedAlignment is not 0, the implementation should choose an image memory layout that requires an alignment no larger than maximumRequestedAlignment as reported in VkMemoryRequirements::alignment. If such a layout does not exist for the given image creation parameters, the implementation should return the smallest alignment which is supported in VkMemoryRequirements.
If an implementation needs to disable image compression for maximumRequestedAlignment to be honored - where a larger alignment would enable image compression - the implementation should not use maximumRequestedAlignment, and should return the smallest alignment which does not compromise compression. If the imageCompressionControl feature is enabled, the application can chain a VkImageCompressionControlEXT with IMAGE_COMPRESSION_DISABLED_EXT. In this case, image compression considerations should not apply when implementation decides alignment.
Valid Usage
- If
maximumRequestedAlignmentis not 0,maximumRequestedAlignmentmust be a power of two - If
maximumRequestedAlignmentis not 0, the bitwise-and ofmaximumRequestedAlignmentandsupportedImageAlignmentMaskmust be non-zero imageAlignmentControlmust be enabled
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMAGE_ALIGNMENT_CONTROL_CREATE_INFO_MESA
Layout
struct VkImageAlignmentControlCreateInfoMESA {
VkStructureType sType();
void const * pNext();
uint32_t maximumRequestedAlignment();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkImageAlignmentControlCreateInfoMESAstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkImageAlignmentControlCreateInfoMESA(ByteBuffer container) Creates aVkImageAlignmentControlCreateInfoMESAinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkImageAlignmentControlCreateInfoMESAinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkImageAlignmentControlCreateInfoMESA.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageAlignmentControlCreateInfoMESA.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageAlignmentControlCreateInfoMESAinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkImageAlignmentControlCreateInfoMESAinstance allocated withBufferUtils.create(int capacity) Returns a newVkImageAlignmentControlCreateInfoMESA.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkImageAlignmentControlCreateInfoMESAinstance for the specified memory address.create(long address, int capacity) Create aVkImageAlignmentControlCreateInfoMESA.Bufferinstance at the specified memory.static @Nullable VkImageAlignmentControlCreateInfoMESAcreateSafe(long address) static @Nullable VkImageAlignmentControlCreateInfoMESA.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkImageAlignmentControlCreateInfoMESAinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkImageAlignmentControlCreateInfoMESA.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageAlignmentControlCreateInfoMESA.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageAlignmentControlCreateInfoMESAinstance allocated on the specifiedMemoryStack.intspecifies the maximum alignment for the image.maximumRequestedAlignment(int value) Sets the specified value to themaximumRequestedAlignment()field.static intnmaximumRequestedAlignment(long struct) Unsafe version ofmaximumRequestedAlignment().static voidnmaximumRequestedAlignment(long struct, int value) Unsafe version ofmaximumRequestedAlignment.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.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, int maximumRequestedAlignment) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_IMAGE_ALIGNMENT_CONTROL_CREATE_INFO_MESAvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods 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. -
MAXIMUMREQUESTEDALIGNMENT
public static final int MAXIMUMREQUESTEDALIGNMENTThe struct member offsets.
-
-
Constructor Details
-
VkImageAlignmentControlCreateInfoMESA
Creates aVkImageAlignmentControlCreateInfoMESAinstance 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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkImageAlignmentControlCreateInfoMESA>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
maximumRequestedAlignment
public int maximumRequestedAlignment()specifies the maximum alignment for the image. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_IMAGE_ALIGNMENT_CONTROL_CREATE_INFO_MESAvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
maximumRequestedAlignment
Sets the specified value to themaximumRequestedAlignment()field. -
set
public VkImageAlignmentControlCreateInfoMESA set(int sType, long pNext, int maximumRequestedAlignment) 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 newVkImageAlignmentControlCreateInfoMESAinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkImageAlignmentControlCreateInfoMESAinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkImageAlignmentControlCreateInfoMESAinstance allocated withBufferUtils. -
create
Returns a newVkImageAlignmentControlCreateInfoMESAinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImageAlignmentControlCreateInfoMESA.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkImageAlignmentControlCreateInfoMESA.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkImageAlignmentControlCreateInfoMESA.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkImageAlignmentControlCreateInfoMESA.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkImageAlignmentControlCreateInfoMESA.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkImageAlignmentControlCreateInfoMESAinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkImageAlignmentControlCreateInfoMESAinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkImageAlignmentControlCreateInfoMESA.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageAlignmentControlCreateInfoMESA.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkImageAlignmentControlCreateInfoMESA.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageAlignmentControlCreateInfoMESA.Bufferinstance allocated on the specifiedMemoryStackand 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(). -
nmaximumRequestedAlignment
public static int nmaximumRequestedAlignment(long struct) Unsafe version ofmaximumRequestedAlignment(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nmaximumRequestedAlignment
public static void nmaximumRequestedAlignment(long struct, int value) Unsafe version ofmaximumRequestedAlignment.
-