Package org.lwjgl.vulkan

Class VkAndroidSurfaceCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAndroidSurfaceCreateInfoKHR>

org.lwjgl.vulkan.VkAndroidSurfaceCreateInfoKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkAndroidSurfaceCreateInfoKHR
extends org.lwjgl.system.Struct<VkAndroidSurfaceCreateInfoKHR>
implements org.lwjgl.system.NativeResource

Structure specifying parameters of a newly created Android surface object.

Valid Usage

• window must point to a valid Android ANativeWindow

Valid Usage (Implicit)

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

See Also

CreateAndroidSurfaceKHR

Layout

 struct VkAndroidSurfaceCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkAndroidSurfaceCreateFlagsKHR flags();
     ANativeWindow * window();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.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.
static final int	WINDOW	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
VkAndroidSurfaceCreateInfoKHR(ByteBuffer container)	Creates a VkAndroidSurfaceCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

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

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

WINDOW

public static final int WINDOW

The struct member offsets.

Constructor Details

VkAndroidSurfaceCreateInfoKHR

public VkAndroidSurfaceCreateInfoKHR(ByteBuffer container)

Creates a VkAndroidSurfaceCreateInfoKHR 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkAndroidSurfaceCreateInfoKHR>

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.

window

public long window()

a pointer to the ANativeWindow to associate the surface with.

sType

public VkAndroidSurfaceCreateInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAndroidSurfaceCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_ANDROID_SURFACE_CREATE_INFO_KHR value to the sType() field.

pNext

public VkAndroidSurfaceCreateInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkAndroidSurfaceCreateInfoKHR flags(int value)

Sets the specified value to the flags() field.

window

public VkAndroidSurfaceCreateInfoKHR window(long value)

Sets the specified value to the window() field.

set

public VkAndroidSurfaceCreateInfoKHR set(int sType,
 long pNext,
 int flags,
 long window)

Initializes this struct with the specified values.

set

public VkAndroidSurfaceCreateInfoKHR set(VkAndroidSurfaceCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAndroidSurfaceCreateInfoKHR malloc()

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

calloc

public static VkAndroidSurfaceCreateInfoKHR calloc()

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

create

public static VkAndroidSurfaceCreateInfoKHR create()

Returns a new VkAndroidSurfaceCreateInfoKHR instance allocated with BufferUtils.

create

public static VkAndroidSurfaceCreateInfoKHR create(long address)

Returns a new VkAndroidSurfaceCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkAndroidSurfaceCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAndroidSurfaceCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAndroidSurfaceCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAndroidSurfaceCreateInfoKHR.Buffer create(int capacity)

Returns a new VkAndroidSurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAndroidSurfaceCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkAndroidSurfaceCreateInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkAndroidSurfaceCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkAndroidSurfaceCreateInfoKHR calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkAndroidSurfaceCreateInfoKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkAndroidSurfaceCreateInfoKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nwindow

public static long nwindow(long struct)

Unsafe version of window().

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.

nwindow

public static void nwindow(long struct,
 long value)

Unsafe version of window.