Package org.lwjgl.vulkan

Class VkHeadlessSurfaceCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkHeadlessSurfaceCreateInfoEXT>

org.lwjgl.vulkan.VkHeadlessSurfaceCreateInfoEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkHeadlessSurfaceCreateInfoEXT
extends Struct<VkHeadlessSurfaceCreateInfoEXT>
implements NativeResource

Structure specifying parameters of a newly created headless surface object.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_HEADLESS_SURFACE_CREATE_INFO_EXT
• pNext must be NULL
• flags must be 0

See Also

CreateHeadlessSurfaceEXT

Layout

 struct VkHeadlessSurfaceCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkHeadlessSurfaceCreateFlagsEXT flags();
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkHeadlessSurfaceCreateInfoEXT	calloc()	Returns a new VkHeadlessSurfaceCreateInfoEXT instance allocated with memCalloc.
static VkHeadlessSurfaceCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkHeadlessSurfaceCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkHeadlessSurfaceCreateInfoEXT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkHeadlessSurfaceCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkHeadlessSurfaceCreateInfoEXT	calloc(MemoryStack stack)	Returns a new VkHeadlessSurfaceCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkHeadlessSurfaceCreateInfoEXT	callocStack()	Deprecated.
static VkHeadlessSurfaceCreateInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkHeadlessSurfaceCreateInfoEXT.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkHeadlessSurfaceCreateInfoEXT	callocStack(MemoryStack stack)	Deprecated.
static VkHeadlessSurfaceCreateInfoEXT	create()	Returns a new VkHeadlessSurfaceCreateInfoEXT instance allocated with BufferUtils.
static VkHeadlessSurfaceCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkHeadlessSurfaceCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkHeadlessSurfaceCreateInfoEXT	create(long address)	Returns a new VkHeadlessSurfaceCreateInfoEXT instance for the specified memory address.
static VkHeadlessSurfaceCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkHeadlessSurfaceCreateInfoEXT.Buffer instance at the specified memory.
static VkHeadlessSurfaceCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static VkHeadlessSurfaceCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	reserved for future use.
VkHeadlessSurfaceCreateInfoEXT	flags(int value)	Sets the specified value to the flags() field.
static VkHeadlessSurfaceCreateInfoEXT	malloc()	Returns a new VkHeadlessSurfaceCreateInfoEXT instance allocated with memAlloc.
static VkHeadlessSurfaceCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkHeadlessSurfaceCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkHeadlessSurfaceCreateInfoEXT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkHeadlessSurfaceCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkHeadlessSurfaceCreateInfoEXT	malloc(MemoryStack stack)	Returns a new VkHeadlessSurfaceCreateInfoEXT instance allocated on the specified MemoryStack.
static VkHeadlessSurfaceCreateInfoEXT	mallocStack()	Deprecated.
static VkHeadlessSurfaceCreateInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkHeadlessSurfaceCreateInfoEXT.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkHeadlessSurfaceCreateInfoEXT	mallocStack(MemoryStack stack)	Deprecated.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkHeadlessSurfaceCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkHeadlessSurfaceCreateInfoEXT	set(int sType, long pNext, int flags)	Initializes this struct with the specified values.
VkHeadlessSurfaceCreateInfoEXT	set(VkHeadlessSurfaceCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkHeadlessSurfaceCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkHeadlessSurfaceCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_HEADLESS_SURFACE_CREATE_INFO_EXT value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.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.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

VkHeadlessSurfaceCreateInfoEXT

public VkHeadlessSurfaceCreateInfoEXT(ByteBuffer container)

Creates a VkHeadlessSurfaceCreateInfoEXT 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<VkHeadlessSurfaceCreateInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

reserved for future use.

sType

public VkHeadlessSurfaceCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkHeadlessSurfaceCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_HEADLESS_SURFACE_CREATE_INFO_EXT value to the sType() field.

pNext

public VkHeadlessSurfaceCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkHeadlessSurfaceCreateInfoEXT flags(int value)

Sets the specified value to the flags() field.

set

public VkHeadlessSurfaceCreateInfoEXT set(int sType,
 long pNext,
 int flags)

Initializes this struct with the specified values.

set

public VkHeadlessSurfaceCreateInfoEXT set(VkHeadlessSurfaceCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkHeadlessSurfaceCreateInfoEXT malloc()

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

calloc

public static VkHeadlessSurfaceCreateInfoEXT calloc()

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

create

public static VkHeadlessSurfaceCreateInfoEXT create()

Returns a new VkHeadlessSurfaceCreateInfoEXT instance allocated with BufferUtils.

create

public static VkHeadlessSurfaceCreateInfoEXT create(long address)

Returns a new VkHeadlessSurfaceCreateInfoEXT instance for the specified memory address.

createSafe

@Nullable
public static VkHeadlessSurfaceCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkHeadlessSurfaceCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkHeadlessSurfaceCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkHeadlessSurfaceCreateInfoEXT.Buffer create(int capacity)

Returns a new VkHeadlessSurfaceCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkHeadlessSurfaceCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkHeadlessSurfaceCreateInfoEXT mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkHeadlessSurfaceCreateInfoEXT callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkHeadlessSurfaceCreateInfoEXT mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkHeadlessSurfaceCreateInfoEXT callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkHeadlessSurfaceCreateInfoEXT.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkHeadlessSurfaceCreateInfoEXT.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkHeadlessSurfaceCreateInfoEXT.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkHeadlessSurfaceCreateInfoEXT.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkHeadlessSurfaceCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkHeadlessSurfaceCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkHeadlessSurfaceCreateInfoEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkHeadlessSurfaceCreateInfoEXT.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().

nflags

public static int nflags(long struct)

Unsafe version of flags().

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.