Class VkSurfaceFormat2KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSurfaceFormat2KHR>

org.lwjgl.vulkan.VkSurfaceFormat2KHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkSurfaceFormat2KHR
extends Struct<VkSurfaceFormat2KHR>
implements NativeResource

struct VkSurfaceFormat2KHR {
    VkStructureType sType;
    void * pNext;
    VkSurfaceFormatKHR surfaceFormat;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSurfaceFormat2KHR.Buffer	An array of VkSurfaceFormat2KHR structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	SURFACEFORMAT	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkSurfaceFormat2KHR(ByteBuffer container)	Creates a VkSurfaceFormat2KHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkSurfaceFormat2KHR	calloc()	Returns a new VkSurfaceFormat2KHR instance allocated with memCalloc.
static VkSurfaceFormat2KHR.Buffer	calloc(int capacity)	Returns a new VkSurfaceFormat2KHR.Buffer instance allocated with memCalloc.
static VkSurfaceFormat2KHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkSurfaceFormat2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSurfaceFormat2KHR	calloc(MemoryStack stack)	Returns a new VkSurfaceFormat2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSurfaceFormat2KHR	create()	Returns a new VkSurfaceFormat2KHR instance allocated with BufferUtils.
static VkSurfaceFormat2KHR.Buffer	create(int capacity)	Returns a new VkSurfaceFormat2KHR.Buffer instance allocated with BufferUtils.
static VkSurfaceFormat2KHR	create(long address)	Returns a new VkSurfaceFormat2KHR instance for the specified memory address.
static VkSurfaceFormat2KHR.Buffer	create(long address, int capacity)	Create a VkSurfaceFormat2KHR.Buffer instance at the specified memory.
static @Nullable VkSurfaceFormat2KHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSurfaceFormat2KHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSurfaceFormat2KHR	malloc()	Returns a new VkSurfaceFormat2KHR instance allocated with memAlloc.
static VkSurfaceFormat2KHR.Buffer	malloc(int capacity)	Returns a new VkSurfaceFormat2KHR.Buffer instance allocated with memAlloc.
static VkSurfaceFormat2KHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkSurfaceFormat2KHR.Buffer instance allocated on the specified MemoryStack.
static VkSurfaceFormat2KHR	malloc(MemoryStack stack)	Returns a new VkSurfaceFormat2KHR instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static VkSurfaceFormatKHR	nsurfaceFormat(long struct)	Unsafe version of surfaceFormat().
long	pNext()
VkSurfaceFormat2KHR	pNext(long value)	Sets the specified value to the pNext field.
VkSurfaceFormat2KHR	pNext(VkImageCompressionPropertiesEXT value)	Prepends the specified VkImageCompressionPropertiesEXT value to the pNext chain.
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()	Returns sizeof(struct).
int	sType()
VkSurfaceFormat2KHR	sType(int value)	Sets the specified value to the sType field.
VkSurfaceFormat2KHR	sType$Default()	Sets the STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR value to the sType field.
VkSurfaceFormatKHR	surfaceFormat()

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

SURFACEFORMAT

public static final int SURFACEFORMAT

The struct member offsets.

Constructor Details

VkSurfaceFormat2KHR

public VkSurfaceFormat2KHR(ByteBuffer container)

Creates a VkSurfaceFormat2KHR instance at the current position of the specified ByteBuffer 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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkSurfaceFormat2KHR>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void *")
public long pNext()

Returns:

the value of the pNext field.

surfaceFormat

public VkSurfaceFormatKHR surfaceFormat()

Returns:

a VkSurfaceFormatKHR view of the surfaceFormat field.

sType

public VkSurfaceFormat2KHR sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkSurfaceFormat2KHR sType$Default()

Sets the STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR value to the sType field.

pNext

public VkSurfaceFormat2KHR pNext(@NativeType("void *")
 long value)

Sets the specified value to the pNext field.

pNext

public VkSurfaceFormat2KHR pNext(VkImageCompressionPropertiesEXT value)

Prepends the specified VkImageCompressionPropertiesEXT value to the pNext chain.

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 new VkSurfaceFormat2KHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkSurfaceFormat2KHR calloc()

Returns a new VkSurfaceFormat2KHR instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkSurfaceFormat2KHR create()

Returns a new VkSurfaceFormat2KHR instance allocated with BufferUtils.

create

public static VkSurfaceFormat2KHR create(long address)

Returns a new VkSurfaceFormat2KHR instance for the specified memory address.

createSafe

public static @Nullable VkSurfaceFormat2KHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSurfaceFormat2KHR.Buffer malloc(int capacity)

Returns a new VkSurfaceFormat2KHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkSurfaceFormat2KHR.Buffer calloc(int capacity)

Returns a new VkSurfaceFormat2KHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkSurfaceFormat2KHR.Buffer create(int capacity)

Returns a new VkSurfaceFormat2KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkSurfaceFormat2KHR.Buffer create(long address,
 int capacity)

Create a VkSurfaceFormat2KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkSurfaceFormat2KHR.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkSurfaceFormat2KHR malloc(MemoryStack stack)

Returns a new VkSurfaceFormat2KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSurfaceFormat2KHR calloc(MemoryStack stack)

Returns a new VkSurfaceFormat2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkSurfaceFormat2KHR.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new VkSurfaceFormat2KHR.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkSurfaceFormat2KHR.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkSurfaceFormat2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nsurfaceFormat

public static VkSurfaceFormatKHR nsurfaceFormat(long struct)

Unsafe version of surfaceFormat().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.