Package org.lwjgl.vulkan
Class VkImageFormatProperties2
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkImageFormatProperties2>
org.lwjgl.vulkan.VkImageFormatProperties2
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkImageFormatProperties2KHR
public class VkImageFormatProperties2
extends org.lwjgl.system.Struct<VkImageFormatProperties2>
implements org.lwjgl.system.NativeResource
Structure specifying an image format properties.
Description
If the combination of parameters to vkGetPhysicalDeviceImageFormatProperties2 is not supported by the implementation for use in CreateImage, then all members of imageFormatProperties will be filled with zero.
Note
Filling imageFormatProperties with zero for unsupported formats is an exception to the usual rule that output structures have undefined contents on error. This exception was unintentional, but is preserved for backwards compatibility. This exception only applies to imageFormatProperties, not sType, pNext, or any structures chained from pNext.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMAGE_FORMAT_PROPERTIES_2- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkAndroidHardwareBufferUsageANDROID,VkExternalImageFormatProperties,VkFilterCubicImageViewImageFormatPropertiesEXT,VkHostImageCopyDevicePerformanceQuery,VkImageCompressionPropertiesEXT,VkSamplerYcbcrConversionImageFormatProperties, orVkTextureLODGatherFormatPropertiesAMD - The
sTypevalue of each struct in thepNextchain must be unique
See Also
VkImageFormatProperties, GetPhysicalDeviceImageFormatProperties2, GetPhysicalDeviceImageFormatProperties2KHR
Layout
struct VkImageFormatProperties2 {
VkStructureType sType();
void * pNext();
VkImageFormatProperties imageFormatProperties();
}-
Nested Class Summary
Nested ClassesNested 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
ConstructorsConstructorDescriptionVkImageFormatProperties2(ByteBuffer container) Creates aVkImageFormatProperties2instance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkImageFormatProperties2calloc()Returns a newVkImageFormatProperties2instance allocated withmemCalloc.calloc(int capacity) Returns a newVkImageFormatProperties2.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageFormatProperties2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageFormatProperties2calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageFormatProperties2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageFormatProperties2Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkImageFormatProperties2callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkImageFormatProperties2create()Returns a newVkImageFormatProperties2instance allocated withBufferUtils.create(int capacity) Returns a newVkImageFormatProperties2.Bufferinstance allocated withBufferUtils.static VkImageFormatProperties2create(long address) Returns a newVkImageFormatProperties2instance for the specified memory address.create(long address, int capacity) Create aVkImageFormatProperties2.Bufferinstance at the specified memory.static @Nullable VkImageFormatProperties2createSafe(long address) static @Nullable VkImageFormatProperties2.BuffercreateSafe(long address, int capacity) aVkImageFormatPropertiesstructure in which capabilities are returned.static VkImageFormatProperties2malloc()Returns a newVkImageFormatProperties2instance allocated withmemAlloc.malloc(int capacity) Returns a newVkImageFormatProperties2.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageFormatProperties2.Bufferinstance allocated on the specifiedMemoryStack.static VkImageFormatProperties2malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageFormatProperties2instance allocated on the specifiedMemoryStack.static VkImageFormatProperties2Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkImageFormatProperties2mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkImageFormatPropertiesnimageFormatProperties(long struct) Unsafe version ofimageFormatProperties().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.Prepends the specifiedVkAndroidHardwareBufferUsageANDROIDvalue to thepNextchain.Prepends the specifiedVkExternalImageFormatPropertiesvalue to thepNextchain.Prepends the specifiedVkExternalImageFormatPropertiesKHRvalue to thepNextchain.Prepends the specifiedVkFilterCubicImageViewImageFormatPropertiesEXTvalue to thepNextchain.Prepends the specifiedVkHostImageCopyDevicePerformanceQueryvalue to thepNextchain.Prepends the specifiedVkHostImageCopyDevicePerformanceQueryEXTvalue to thepNextchain.Prepends the specifiedVkImageCompressionPropertiesEXTvalue to thepNextchain.Prepends the specifiedVkSamplerYcbcrConversionImageFormatPropertiesvalue to thepNextchain.Prepends the specifiedVkSamplerYcbcrConversionImageFormatPropertiesKHRvalue to thepNextchain.Prepends the specifiedVkTextureLODGatherFormatPropertiesAMDvalue to thepNextchain.set(int sType, long pNext) 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_FORMAT_PROPERTIES_2value 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. -
IMAGEFORMATPROPERTIES
public static final int IMAGEFORMATPROPERTIESThe struct member offsets.
-
-
Constructor Details
-
VkImageFormatProperties2
Creates aVkImageFormatProperties2instance 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<VkImageFormatProperties2>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. ThepNextchain ofVkImageFormatProperties2is used to allow the specification of additional capabilities to be returned fromvkGetPhysicalDeviceImageFormatProperties2. -
imageFormatProperties
aVkImageFormatPropertiesstructure in which capabilities are returned. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_IMAGE_FORMAT_PROPERTIES_2value to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkAndroidHardwareBufferUsageANDROIDvalue to thepNextchain. -
pNext
Prepends the specifiedVkExternalImageFormatPropertiesvalue to thepNextchain. -
pNext
Prepends the specifiedVkExternalImageFormatPropertiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkFilterCubicImageViewImageFormatPropertiesEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkHostImageCopyDevicePerformanceQueryvalue to thepNextchain. -
pNext
Prepends the specifiedVkHostImageCopyDevicePerformanceQueryEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkImageCompressionPropertiesEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkSamplerYcbcrConversionImageFormatPropertiesvalue to thepNextchain. -
pNext
Prepends the specifiedVkSamplerYcbcrConversionImageFormatPropertiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkTextureLODGatherFormatPropertiesAMDvalue to thepNextchain. -
set
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 newVkImageFormatProperties2instance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkImageFormatProperties2instance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkImageFormatProperties2instance allocated withBufferUtils. -
create
Returns a newVkImageFormatProperties2instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImageFormatProperties2.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkImageFormatProperties2.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkImageFormatProperties2.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkImageFormatProperties2.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkImageFormatProperties2.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 VkImageFormatProperties2.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkImageFormatProperties2instance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkImageFormatProperties2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkImageFormatProperties2.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageFormatProperties2.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkImageFormatProperties2.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageFormatProperties2.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(). -
nimageFormatProperties
Unsafe version ofimageFormatProperties(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext.
-