Package org.lwjgl.vulkan
Class VkImageFormatProperties2
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageFormatProperties2
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,NativeResource
,Pointer
- Direct Known Subclasses:
VkImageFormatProperties2KHR
public class VkImageFormatProperties2 extends Struct implements NativeResource
Structure specifying an image format properties.Description
If the combination of parameters to
GetPhysicalDeviceImageFormatProperties2
is not supported by the implementation for use inCreateImage
, then all members ofimageFormatProperties
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 exeption only applies toimageFormatProperties
, notsType
,pNext
, or any structures chained frompNext
.Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_IMAGE_FORMAT_PROPERTIES_2
- Each
pNext
member of any structure (including this one) in thepNext
chain must be eitherNULL
or a pointer to a valid instance ofVkExternalImageFormatProperties
,VkSamplerYcbcrConversionImageFormatProperties
, orVkTextureLODGatherFormatPropertiesAMD
- Each
sType
member in thepNext
chain must be unique
See Also
VkImageFormatProperties
,GetPhysicalDeviceImageFormatProperties2
,GetPhysicalDeviceImageFormatProperties2KHR
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure. ThepNext
chain ofVkImageFormatProperties2
is used to allow the specification of additional capabilities to be returned fromGetPhysicalDeviceImageFormatProperties2
.imageFormatProperties
– an instance of aVkImageFormatProperties
structure in which capabilities are returned.
Layout
struct VkImageFormatProperties2 { VkStructureType sType; void * pNext;
VkImageFormatProperties
imageFormatProperties; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkImageFormatProperties2.Buffer
An array ofVkImageFormatProperties2
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
IMAGEFORMATPROPERTIES
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.-
Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor Description VkImageFormatProperties2(java.nio.ByteBuffer container)
Creates aVkImageFormatProperties2
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 VkImageFormatProperties2
calloc()
Returns a newVkImageFormatProperties2
instance allocated withmemCalloc
.static VkImageFormatProperties2.Buffer
calloc(int capacity)
Returns a newVkImageFormatProperties2.Buffer
instance allocated withmemCalloc
.static VkImageFormatProperties2
callocStack()
Returns a newVkImageFormatProperties2
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageFormatProperties2.Buffer
callocStack(int capacity)
Returns a newVkImageFormatProperties2.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageFormatProperties2.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkImageFormatProperties2.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageFormatProperties2
callocStack(MemoryStack stack)
Returns a newVkImageFormatProperties2
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageFormatProperties2
create()
Returns a newVkImageFormatProperties2
instance allocated withBufferUtils
.static VkImageFormatProperties2.Buffer
create(int capacity)
Returns a newVkImageFormatProperties2.Buffer
instance allocated withBufferUtils
.static VkImageFormatProperties2
create(long address)
Returns a newVkImageFormatProperties2
instance for the specified memory address.static VkImageFormatProperties2.Buffer
create(long address, int capacity)
Create aVkImageFormatProperties2.Buffer
instance at the specified memory.static VkImageFormatProperties2
createSafe(long address)
static VkImageFormatProperties2.Buffer
createSafe(long address, int capacity)
VkImageFormatProperties
imageFormatProperties()
Returns aVkImageFormatProperties
view of theimageFormatProperties
field.static VkImageFormatProperties2
malloc()
Returns a newVkImageFormatProperties2
instance allocated withmemAlloc
.static VkImageFormatProperties2.Buffer
malloc(int capacity)
Returns a newVkImageFormatProperties2.Buffer
instance allocated withmemAlloc
.static VkImageFormatProperties2
mallocStack()
Returns a newVkImageFormatProperties2
instance allocated on the thread-localMemoryStack
.static VkImageFormatProperties2.Buffer
mallocStack(int capacity)
Returns a newVkImageFormatProperties2.Buffer
instance allocated on the thread-localMemoryStack
.static VkImageFormatProperties2.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageFormatProperties2.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageFormatProperties2
mallocStack(MemoryStack stack)
Returns a newVkImageFormatProperties2
instance allocated on the specifiedMemoryStack
.static VkImageFormatProperties
nimageFormatProperties(long struct)
Unsafe version ofimageFormatProperties()
.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
.long
pNext()
Returns the value of thepNext
field.VkImageFormatProperties2
pNext(long value)
Sets the specified value to thepNext
field.VkImageFormatProperties2
set(int sType, long pNext)
Initializes this struct with the specified values.VkImageFormatProperties2
set(VkImageFormatProperties2 src)
Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
Returns the value of thesType
field.VkImageFormatProperties2
sType(int value)
Sets the specified value to thesType
field.-
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
-
-
-
Constructor Detail
-
VkImageFormatProperties2
public VkImageFormatProperties2(java.nio.ByteBuffer container)
Creates aVkImageFormatProperties2
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()
Description copied from class:Struct
Returnssizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
imageFormatProperties
public VkImageFormatProperties imageFormatProperties()
Returns aVkImageFormatProperties
view of theimageFormatProperties
field.
-
sType
public VkImageFormatProperties2 sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkImageFormatProperties2 pNext(long value)
Sets the specified value to thepNext
field.
-
set
public VkImageFormatProperties2 set(int sType, long pNext)
Initializes this struct with the specified values.
-
set
public VkImageFormatProperties2 set(VkImageFormatProperties2 src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkImageFormatProperties2 malloc()
Returns a newVkImageFormatProperties2
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImageFormatProperties2 calloc()
Returns a newVkImageFormatProperties2
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImageFormatProperties2 create()
Returns a newVkImageFormatProperties2
instance allocated withBufferUtils
.
-
create
public static VkImageFormatProperties2 create(long address)
Returns a newVkImageFormatProperties2
instance for the specified memory address.
-
createSafe
@Nullable public static VkImageFormatProperties2 createSafe(long address)
-
malloc
public static VkImageFormatProperties2.Buffer malloc(int capacity)
Returns a newVkImageFormatProperties2.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImageFormatProperties2.Buffer calloc(int capacity)
Returns a newVkImageFormatProperties2.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageFormatProperties2.Buffer create(int capacity)
Returns a newVkImageFormatProperties2.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageFormatProperties2.Buffer create(long address, int capacity)
Create aVkImageFormatProperties2.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkImageFormatProperties2.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkImageFormatProperties2 mallocStack()
Returns a newVkImageFormatProperties2
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImageFormatProperties2 callocStack()
Returns a newVkImageFormatProperties2
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImageFormatProperties2 mallocStack(MemoryStack stack)
Returns a newVkImageFormatProperties2
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImageFormatProperties2 callocStack(MemoryStack stack)
Returns a newVkImageFormatProperties2
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkImageFormatProperties2.Buffer mallocStack(int capacity)
Returns a newVkImageFormatProperties2.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImageFormatProperties2.Buffer callocStack(int capacity)
Returns a newVkImageFormatProperties2.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkImageFormatProperties2.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageFormatProperties2.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkImageFormatProperties2.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkImageFormatProperties2.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()
.
-
nimageFormatProperties
public static VkImageFormatProperties nimageFormatProperties(long struct)
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
.
-
-