Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkWaylandSurfaceCreateInfoKHR

extends Struct<VkWaylandSurfaceCreateInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*, org.lwjgl.system.linux.*

Structure specifying parameters of a newly created Wayland surface object.
Valid Usage
Valid Usage (Implicit)
See Also

CreateWaylandSurfaceKHR

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DISPLAY

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
SURFACE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkWaylandSurfaceCreateInfoKHR(long address, ByteBuffer container)

public
VkWaylandSurfaceCreateInfoKHR(ByteBuffer container)

Creates a VkWaylandSurfaceCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkWaylandSurfaceCreateInfoKHR
calloc()

Returns a new VkWaylandSurfaceCreateInfoKHR instance allocated with memCalloc.

public static VkWaylandSurfaceCreateInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkWaylandSurfaceCreateInfoKHR.Buffer instance allocated with memCalloc.

public static VkWaylandSurfaceCreateInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkWaylandSurfaceCreateInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkWaylandSurfaceCreateInfoKHR
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkWaylandSurfaceCreateInfoKHR
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkWaylandSurfaceCreateInfoKHR.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkWaylandSurfaceCreateInfoKHR.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkWaylandSurfaceCreateInfoKHR
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkWaylandSurfaceCreateInfoKHR
create()

Returns a new VkWaylandSurfaceCreateInfoKHR instance allocated with BufferUtils.

public static VkWaylandSurfaceCreateInfoKHR
create(long address)

Returns a new VkWaylandSurfaceCreateInfoKHR instance for the specified memory address.

public static VkWaylandSurfaceCreateInfoKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkWaylandSurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkWaylandSurfaceCreateInfoKHR.Buffer instance at the specified memory.

public static VkWaylandSurfaceCreateInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
display()

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

public VkWaylandSurfaceCreateInfoKHR
display(long value)

Sets the specified value to the display field.

public int
flags()

reserved for future use.

public VkWaylandSurfaceCreateInfoKHR
flags(int value)

Sets the specified value to the flags field.

public static VkWaylandSurfaceCreateInfoKHR
malloc()

Returns a new VkWaylandSurfaceCreateInfoKHR instance allocated with memAlloc.

public static VkWaylandSurfaceCreateInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkWaylandSurfaceCreateInfoKHR.Buffer instance allocated with memAlloc.

public static VkWaylandSurfaceCreateInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkWaylandSurfaceCreateInfoKHR instance allocated on the specified MemoryStack.

public static VkWaylandSurfaceCreateInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkWaylandSurfaceCreateInfoKHR
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkWaylandSurfaceCreateInfoKHR
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkWaylandSurfaceCreateInfoKHR.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkWaylandSurfaceCreateInfoKHR.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
ndisplay(long struct)

Unsafe version of display.

public static void
ndisplay(long struct, long value)

Unsafe version of display.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static long
nsurface(long struct)

Unsafe version of surface.

public static void
nsurface(long struct, long value)

Unsafe version of surface.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkWaylandSurfaceCreateInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkWaylandSurfaceCreateInfoKHR

Returns:

this struct
set
(VkWaylandSurfaceCreateInfoKHR
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkWaylandSurfaceCreateInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkWaylandSurfaceCreateInfoKHR
public long
surface()

see display

public VkWaylandSurfaceCreateInfoKHR
surface(long value)

Sets the specified value to the surface field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DISPLAYback to summary
public static final int DISPLAY

The struct member offsets.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

SURFACEback to summary
public static final int SURFACE

The struct member offsets.

Constructor Detail

VkWaylandSurfaceCreateInfoKHRback to summary
protected VkWaylandSurfaceCreateInfoKHR(long address, ByteBuffer container)
VkWaylandSurfaceCreateInfoKHRback to summary
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 Detail

callocback to summary
public static VkWaylandSurfaceCreateInfoKHR calloc()

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

callocback to summary
public static VkWaylandSurfaceCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkWaylandSurfaceCreateInfoKHR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkWaylandSurfaceCreateInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkWaylandSurfaceCreateInfoKHR callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkWaylandSurfaceCreateInfoKHR callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkWaylandSurfaceCreateInfoKHR.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkWaylandSurfaceCreateInfoKHR.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkWaylandSurfaceCreateInfoKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkWaylandSurfaceCreateInfoKHR create()

Returns a new VkWaylandSurfaceCreateInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkWaylandSurfaceCreateInfoKHR create(long address)

Returns a new VkWaylandSurfaceCreateInfoKHR instance for the specified memory address.

createback to summary
public static VkWaylandSurfaceCreateInfoKHR.Buffer create(int capacity)

Returns a new VkWaylandSurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkWaylandSurfaceCreateInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkWaylandSurfaceCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkWaylandSurfaceCreateInfoKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
displayback to summary
public long display()

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

Annotations
@NativeType:struct wl_display *
displayback to summary
public VkWaylandSurfaceCreateInfoKHR display(long value)

Sets the specified value to the display field.

flagsback to summary
public int flags()

reserved for future use.

Annotations
@NativeType:VkWaylandSurfaceCreateFlagsKHR
flagsback to summary
public VkWaylandSurfaceCreateInfoKHR flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkWaylandSurfaceCreateInfoKHR malloc()

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

mallocback to summary
public static VkWaylandSurfaceCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkWaylandSurfaceCreateInfoKHR malloc(MemoryStack stack)

Returns a new VkWaylandSurfaceCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkWaylandSurfaceCreateInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkWaylandSurfaceCreateInfoKHR mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkWaylandSurfaceCreateInfoKHR mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkWaylandSurfaceCreateInfoKHR.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkWaylandSurfaceCreateInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
ndisplayback to summary
public static long ndisplay(long struct)

Unsafe version of display.

ndisplayback to summary
public static void ndisplay(long struct, long value)

Unsafe version of display.

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

nsurfaceback to summary
public static long nsurface(long struct)

Unsafe version of surface.

nsurfaceback to summary
public static void nsurface(long struct, long value)

Unsafe version of surface.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkWaylandSurfaceCreateInfoKHR pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkWaylandSurfaceCreateInfoKHR set(VkWaylandSurfaceCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkWaylandSurfaceCreateInfoKHR

the source struct

Returns:VkWaylandSurfaceCreateInfoKHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkWaylandSurfaceCreateInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkWaylandSurfaceCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_WAYLAND_SURFACE_CREATE_INFO_KHR value to the sType field.

surfaceback to summary
public long surface()

see display

Annotations
@NativeType:struct wl_surface *
surfaceback to summary
public VkWaylandSurfaceCreateInfoKHR surface(long value)

Sets the specified value to the surface field.

org.lwjgl.vulkan back to summary

public Class VkWaylandSurfaceCreateInfoKHR.Buffer

extends StructBuffer<VkWaylandSurfaceCreateInfoKHR, VkWaylandSurfaceCreateInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkWaylandSurfaceCreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkWaylandSurfaceCreateInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkWaylandSurfaceCreateInfoKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the VkWaylandSurfaceCreateInfoKHR#display field.
display
()

public VkWaylandSurfaceCreateInfoKHR.Buffer
display(long value)

Sets the specified value to the VkWaylandSurfaceCreateInfoKHR#display field.

public int

Returns:

the value of the VkWaylandSurfaceCreateInfoKHR#flags field.
flags
()

public VkWaylandSurfaceCreateInfoKHR.Buffer
flags(int value)

Sets the specified value to the VkWaylandSurfaceCreateInfoKHR#flags field.

protected VkWaylandSurfaceCreateInfoKHR
public long

Returns:

the value of the VkWaylandSurfaceCreateInfoKHR#pNext field.
pNext
()

public VkWaylandSurfaceCreateInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkWaylandSurfaceCreateInfoKHR#pNext field.

protected VkWaylandSurfaceCreateInfoKHR.Buffer
public int

Returns:

the value of the VkWaylandSurfaceCreateInfoKHR#sType field.
sType
()

public VkWaylandSurfaceCreateInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkWaylandSurfaceCreateInfoKHR#sType field.

public VkWaylandSurfaceCreateInfoKHR.Buffer
public long

Returns:

the value of the VkWaylandSurfaceCreateInfoKHR#surface field.
surface
()

public VkWaylandSurfaceCreateInfoKHR.Buffer
surface(long value)

Sets the specified value to the VkWaylandSurfaceCreateInfoKHR#surface field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkWaylandSurfaceCreateInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkWaylandSurfaceCreateInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkWaylandSurfaceCreateInfoKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

displayback to summary
public long display()
Returns:long

the value of the VkWaylandSurfaceCreateInfoKHR#display field.

Annotations
@NativeType:struct wl_display *
displayback to summary
public VkWaylandSurfaceCreateInfoKHR.Buffer display(long value)

Sets the specified value to the VkWaylandSurfaceCreateInfoKHR#display field.

flagsback to summary
public int flags()
Returns:int

the value of the VkWaylandSurfaceCreateInfoKHR#flags field.

Annotations
@NativeType:VkWaylandSurfaceCreateFlagsKHR
flagsback to summary
public VkWaylandSurfaceCreateInfoKHR.Buffer flags(int value)

Sets the specified value to the VkWaylandSurfaceCreateInfoKHR#flags field.

getElementFactoryback to summary
protected VkWaylandSurfaceCreateInfoKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkWaylandSurfaceCreateInfoKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkWaylandSurfaceCreateInfoKHR.Buffer pNext(long value)

Sets the specified value to the VkWaylandSurfaceCreateInfoKHR#pNext field.

selfback to summary
protected VkWaylandSurfaceCreateInfoKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkWaylandSurfaceCreateInfoKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkWaylandSurfaceCreateInfoKHR.Buffer sType(int value)

Sets the specified value to the VkWaylandSurfaceCreateInfoKHR#sType field.

sType$Defaultback to summary
public VkWaylandSurfaceCreateInfoKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_WAYLAND_SURFACE_CREATE_INFO_KHR value to the VkWaylandSurfaceCreateInfoKHR#sType field.

surfaceback to summary
public long surface()
Returns:long

the value of the VkWaylandSurfaceCreateInfoKHR#surface field.

Annotations
@NativeType:struct wl_surface *
surfaceback to summary
public VkWaylandSurfaceCreateInfoKHR.Buffer surface(long value)

Sets the specified value to the VkWaylandSurfaceCreateInfoKHR#surface field.