Package org.lwjgl.vulkan

Class VkWaylandSurfaceCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkWaylandSurfaceCreateInfoKHR>

org.lwjgl.vulkan.VkWaylandSurfaceCreateInfoKHR

All Implemented Interfaces:

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

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

Structure specifying parameters of a newly created Wayland surface object.

Valid Usage

• display must point to a valid Wayland wl_display
• surface must point to a valid Wayland wl_surface

Valid Usage (Implicit)

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

See Also

CreateWaylandSurfaceKHR

Layout

 struct VkWaylandSurfaceCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkWaylandSurfaceCreateFlagsKHR flags();
     struct wl_display * display();
     struct wl_surface * surface();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkWaylandSurfaceCreateInfoKHR.Buffer	An array of VkWaylandSurfaceCreateInfoKHR 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	DISPLAY	The struct member offsets.
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	SURFACE	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
VkWaylandSurfaceCreateInfoKHR(ByteBuffer container)	Creates a VkWaylandSurfaceCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

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

DISPLAY

public static final int DISPLAY

The struct member offsets.

SURFACE

public static final int SURFACE

The struct member offsets.

Constructor Details

VkWaylandSurfaceCreateInfoKHR

public VkWaylandSurfaceCreateInfoKHR(ByteBuffer container)

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

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.

display

public long display()

display and surface are pointers to the Wayland wl_display and wl_surface to associate the surface with.

surface

public long surface()

see display

sType

public VkWaylandSurfaceCreateInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkWaylandSurfaceCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_WAYLAND_SURFACE_CREATE_INFO_KHR value to the sType() field.

pNext

public VkWaylandSurfaceCreateInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkWaylandSurfaceCreateInfoKHR flags(int value)

Sets the specified value to the flags() field.

display

public VkWaylandSurfaceCreateInfoKHR display(long value)

Sets the specified value to the display() field.

surface

public VkWaylandSurfaceCreateInfoKHR surface(long value)

Sets the specified value to the surface() field.

set

public VkWaylandSurfaceCreateInfoKHR set(int sType,
 long pNext,
 int flags,
 long display,
 long surface)

Initializes this struct with the specified values.

set

public VkWaylandSurfaceCreateInfoKHR set(VkWaylandSurfaceCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkWaylandSurfaceCreateInfoKHR malloc()

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

calloc

public static VkWaylandSurfaceCreateInfoKHR calloc()

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

create

public static VkWaylandSurfaceCreateInfoKHR create()

Returns a new VkWaylandSurfaceCreateInfoKHR instance allocated with BufferUtils.

create

public static VkWaylandSurfaceCreateInfoKHR create(long address)

Returns a new VkWaylandSurfaceCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkWaylandSurfaceCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkWaylandSurfaceCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkWaylandSurfaceCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkWaylandSurfaceCreateInfoKHR.Buffer create(int capacity)

Returns a new VkWaylandSurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkWaylandSurfaceCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkWaylandSurfaceCreateInfoKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkWaylandSurfaceCreateInfoKHR callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkWaylandSurfaceCreateInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkWaylandSurfaceCreateInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkWaylandSurfaceCreateInfoKHR.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkWaylandSurfaceCreateInfoKHR.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

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

Returns a new VkWaylandSurfaceCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ndisplay

public static long ndisplay(long struct)

Unsafe version of display().

nsurface

public static long nsurface(long struct)

Unsafe version of surface().

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.

ndisplay

public static void ndisplay(long struct,
 long value)

Unsafe version of display.

nsurface

public static void nsurface(long struct,
 long value)

Unsafe version of surface.