Package org.lwjgl.vulkan
Class VkSurfaceFormat2KHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSurfaceFormat2KHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkSurfaceFormat2KHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure describing a supported swapchain format tuple.Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_SURFACE_FORMAT_2_KHR
pNext
must beNULL
See Also
VkSurfaceFormatKHR
,GetPhysicalDeviceSurfaceFormats2KHR
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.surfaceFormat
– an instance ofVkSurfaceFormatKHR
describing a format-color space pair that is compatible with the specified surface.
Layout
struct VkSurfaceFormat2KHR { VkStructureType sType; void * pNext;
VkSurfaceFormatKHR
surfaceFormat; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkSurfaceFormat2KHR.Buffer
An array ofVkSurfaceFormat2KHR
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
PNEXT
The struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
SURFACEFORMATThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkSurfaceFormat2KHR(java.nio.ByteBuffer container)
Creates aVkSurfaceFormat2KHR
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 VkSurfaceFormat2KHR
calloc()
Returns a newVkSurfaceFormat2KHR
instance allocated withmemCalloc
.static VkSurfaceFormat2KHR.Buffer
calloc(int capacity)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated withmemCalloc
.static VkSurfaceFormat2KHR
callocStack()
Returns a newVkSurfaceFormat2KHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSurfaceFormat2KHR.Buffer
callocStack(int capacity)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSurfaceFormat2KHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSurfaceFormat2KHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceFormat2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSurfaceFormat2KHR
create()
Returns a newVkSurfaceFormat2KHR
instance allocated withBufferUtils
.static VkSurfaceFormat2KHR.Buffer
create(int capacity)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated withBufferUtils
.static VkSurfaceFormat2KHR
create(long address)
Returns a newVkSurfaceFormat2KHR
instance for the specified memory address.static VkSurfaceFormat2KHR.Buffer
create(long address, int capacity)
Create aVkSurfaceFormat2KHR.Buffer
instance at the specified memory.static VkSurfaceFormat2KHR
createSafe(long address)
static VkSurfaceFormat2KHR.Buffer
createSafe(long address, int capacity)
static VkSurfaceFormat2KHR
malloc()
Returns a newVkSurfaceFormat2KHR
instance allocated withmemAlloc
.static VkSurfaceFormat2KHR.Buffer
malloc(int capacity)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated withmemAlloc
.static VkSurfaceFormat2KHR
mallocStack()
Returns a newVkSurfaceFormat2KHR
instance allocated on the thread-localMemoryStack
.static VkSurfaceFormat2KHR.Buffer
mallocStack(int capacity)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkSurfaceFormat2KHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkSurfaceFormat2KHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceFormat2KHR
instance allocated on the specifiedMemoryStack
.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
.static VkSurfaceFormatKHR
nsurfaceFormat(long struct)
Unsafe version ofsurfaceFormat()
.long
pNext()
Returns the value of thepNext
field.VkSurfaceFormat2KHR
pNext(long value)
Sets the specified value to thepNext
field.VkSurfaceFormat2KHR
set(int sType, long pNext)
Initializes this struct with the specified values.VkSurfaceFormat2KHR
set(VkSurfaceFormat2KHR src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkSurfaceFormat2KHR
sType(int value)
Sets the specified value to thesType
field.VkSurfaceFormatKHR
surfaceFormat()
Returns aVkSurfaceFormatKHR
view of thesurfaceFormat
field.
-
-
-
Constructor Detail
-
VkSurfaceFormat2KHR
public VkSurfaceFormat2KHR(java.nio.ByteBuffer container)
Creates aVkSurfaceFormat2KHR
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()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
surfaceFormat
public VkSurfaceFormatKHR surfaceFormat()
Returns aVkSurfaceFormatKHR
view of thesurfaceFormat
field.
-
sType
public VkSurfaceFormat2KHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkSurfaceFormat2KHR pNext(long value)
Sets the specified value to thepNext
field.
-
set
public VkSurfaceFormat2KHR set(int sType, long pNext)
Initializes this struct with the specified values.
-
set
public VkSurfaceFormat2KHR set(VkSurfaceFormat2KHR src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkSurfaceFormat2KHR malloc()
Returns a newVkSurfaceFormat2KHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkSurfaceFormat2KHR calloc()
Returns a newVkSurfaceFormat2KHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkSurfaceFormat2KHR create()
Returns a newVkSurfaceFormat2KHR
instance allocated withBufferUtils
.
-
create
public static VkSurfaceFormat2KHR create(long address)
Returns a newVkSurfaceFormat2KHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkSurfaceFormat2KHR createSafe(long address)
-
malloc
public static VkSurfaceFormat2KHR.Buffer malloc(int capacity)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkSurfaceFormat2KHR.Buffer calloc(int capacity)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSurfaceFormat2KHR.Buffer create(int capacity)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSurfaceFormat2KHR.Buffer create(long address, int capacity)
Create aVkSurfaceFormat2KHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkSurfaceFormat2KHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkSurfaceFormat2KHR mallocStack()
Returns a newVkSurfaceFormat2KHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkSurfaceFormat2KHR callocStack()
Returns a newVkSurfaceFormat2KHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkSurfaceFormat2KHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceFormat2KHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkSurfaceFormat2KHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceFormat2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkSurfaceFormat2KHR.Buffer mallocStack(int capacity)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkSurfaceFormat2KHR.Buffer callocStack(int capacity)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkSurfaceFormat2KHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkSurfaceFormat2KHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceFormat2KHR.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()
.
-
nsurfaceFormat
public static VkSurfaceFormatKHR nsurfaceFormat(long struct)
Unsafe version ofsurfaceFormat()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
-