Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkXcbSurfaceCreateInfoKHR

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

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

CreateXcbSurfaceKHR

Layout


struct VkXcbSurfaceCreateInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkXcbSurfaceCreateFlagsKHR flags;
    xcb_connection_t * connection;
    xcb_window_t window;
}

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
CONNECTION

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
WINDOW

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkXcbSurfaceCreateInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkXcbSurfaceCreateInfoKHR
calloc()

Returns a new VkXcbSurfaceCreateInfoKHR instance allocated with memCalloc.

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

Returns a new VkXcbSurfaceCreateInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public long
connection()

a pointer to an xcb_connection_t to the X server.

public VkXcbSurfaceCreateInfoKHR
connection(long value)

Sets the specified value to the connection field.

protected VkXcbSurfaceCreateInfoKHR
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 VkXcbSurfaceCreateInfoKHR
create()

Returns a new VkXcbSurfaceCreateInfoKHR instance allocated with BufferUtils.

public static VkXcbSurfaceCreateInfoKHR
create(long address)

Returns a new VkXcbSurfaceCreateInfoKHR instance for the specified memory address.

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

Returns a new VkXcbSurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkXcbSurfaceCreateInfoKHR.Buffer instance at the specified memory.

public static VkXcbSurfaceCreateInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

reserved for future use.

public VkXcbSurfaceCreateInfoKHR
flags(int value)

Sets the specified value to the flags field.

public static VkXcbSurfaceCreateInfoKHR
malloc()

Returns a new VkXcbSurfaceCreateInfoKHR instance allocated with memAlloc.

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

Returns a new VkXcbSurfaceCreateInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkXcbSurfaceCreateInfoKHR instance allocated on the specified MemoryStack.

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

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

public static long
nconnection(long struct)

Unsafe version of connection.

public static void
nconnection(long struct, long value)

Unsafe version of connection.

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 int
nwindow(long struct)

Unsafe version of window.

public static void
nwindow(long struct, int value)

Unsafe version of window.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkXcbSurfaceCreateInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkXcbSurfaceCreateInfoKHR
set(int sType, long pNext, int flags, long connection, int window)

Initializes this struct with the specified values.

public VkXcbSurfaceCreateInfoKHR

Returns:

this struct
set
(VkXcbSurfaceCreateInfoKHR
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 VkXcbSurfaceCreateInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkXcbSurfaceCreateInfoKHR
public int
window()

the xcb_window_t for the X11 window to associate the surface with.

public VkXcbSurfaceCreateInfoKHR
window(int value)

Sets the specified value to the window 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.

CONNECTIONback to summary
public static final int CONNECTION

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.

WINDOWback to summary
public static final int WINDOW

The struct member offsets.

Constructor Detail

VkXcbSurfaceCreateInfoKHRback to summary
protected VkXcbSurfaceCreateInfoKHR(long address, ByteBuffer container)
VkXcbSurfaceCreateInfoKHRback to summary
public VkXcbSurfaceCreateInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkXcbSurfaceCreateInfoKHR calloc(MemoryStack stack)

Returns a new VkXcbSurfaceCreateInfoKHR 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 VkXcbSurfaceCreateInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkXcbSurfaceCreateInfoKHR.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

connectionback to summary
public long connection()

a pointer to an xcb_connection_t to the X server.

Annotations
@NativeType:xcb_connection_t *
connectionback to summary
public VkXcbSurfaceCreateInfoKHR connection(long value)

Sets the specified value to the connection field.

createback to summary
protected VkXcbSurfaceCreateInfoKHR 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 VkXcbSurfaceCreateInfoKHR create()

Returns a new VkXcbSurfaceCreateInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkXcbSurfaceCreateInfoKHR create(long address)

Returns a new VkXcbSurfaceCreateInfoKHR instance for the specified memory address.

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

Returns a new VkXcbSurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkXcbSurfaceCreateInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkXcbSurfaceCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

reserved for future use.

Annotations
@NativeType:VkXcbSurfaceCreateFlagsKHR
flagsback to summary
public VkXcbSurfaceCreateInfoKHR flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkXcbSurfaceCreateInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkXcbSurfaceCreateInfoKHR malloc(MemoryStack stack)

Returns a new VkXcbSurfaceCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nconnectionback to summary
public static long nconnection(long struct)

Unsafe version of connection.

nconnectionback to summary
public static void nconnection(long struct, long value)

Unsafe version of connection.

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.

nwindowback to summary
public static int nwindow(long struct)

Unsafe version of window.

nwindowback to summary
public static void nwindow(long struct, int value)

Unsafe version of window.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkXcbSurfaceCreateInfoKHR set(int sType, long pNext, int flags, long connection, int window)

Initializes this struct with the specified values.

setback to summary
public VkXcbSurfaceCreateInfoKHR set(VkXcbSurfaceCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkXcbSurfaceCreateInfoKHR

the source struct

Returns:VkXcbSurfaceCreateInfoKHR

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 VkXcbSurfaceCreateInfoKHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_XCB_SURFACE_CREATE_INFO_KHR value to the sType field.

windowback to summary
public int window()

the xcb_window_t for the X11 window to associate the surface with.

Annotations
@NativeType:xcb_window_t
windowback to summary
public VkXcbSurfaceCreateInfoKHR window(int value)

Sets the specified value to the window field.

org.lwjgl.vulkan back to summary

public Class VkXcbSurfaceCreateInfoKHR.Buffer

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

An array of VkXcbSurfaceCreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkXcbSurfaceCreateInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkXcbSurfaceCreateInfoKHR.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 VkXcbSurfaceCreateInfoKHR#connection field.
connection
()

public VkXcbSurfaceCreateInfoKHR.Buffer
connection(long value)

Sets the specified value to the VkXcbSurfaceCreateInfoKHR#connection field.

public int

Returns:

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

public VkXcbSurfaceCreateInfoKHR.Buffer
flags(int value)

Sets the specified value to the VkXcbSurfaceCreateInfoKHR#flags field.

protected VkXcbSurfaceCreateInfoKHR
public long

Returns:

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

public VkXcbSurfaceCreateInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkXcbSurfaceCreateInfoKHR#pNext field.

protected VkXcbSurfaceCreateInfoKHR.Buffer
public int

Returns:

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

public VkXcbSurfaceCreateInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkXcbSurfaceCreateInfoKHR#sType field.

public VkXcbSurfaceCreateInfoKHR.Buffer
public int

Returns:

the value of the VkXcbSurfaceCreateInfoKHR#window field.
window
()

public VkXcbSurfaceCreateInfoKHR.Buffer
window(int value)

Sets the specified value to the VkXcbSurfaceCreateInfoKHR#window field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkXcbSurfaceCreateInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkXcbSurfaceCreateInfoKHR.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 VkXcbSurfaceCreateInfoKHR#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

connectionback to summary
public long connection()
Returns:long

the value of the VkXcbSurfaceCreateInfoKHR#connection field.

Annotations
@NativeType:xcb_connection_t *
connectionback to summary
public VkXcbSurfaceCreateInfoKHR.Buffer connection(long value)

Sets the specified value to the VkXcbSurfaceCreateInfoKHR#connection field.

flagsback to summary
public int flags()
Returns:int

the value of the VkXcbSurfaceCreateInfoKHR#flags field.

Annotations
@NativeType:VkXcbSurfaceCreateFlagsKHR
flagsback to summary
public VkXcbSurfaceCreateInfoKHR.Buffer flags(int value)

Sets the specified value to the VkXcbSurfaceCreateInfoKHR#flags field.

getElementFactoryback to summary
protected VkXcbSurfaceCreateInfoKHR getElementFactory()

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

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

the value of the VkXcbSurfaceCreateInfoKHR#pNext field.

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

Sets the specified value to the VkXcbSurfaceCreateInfoKHR#pNext field.

selfback to summary
protected VkXcbSurfaceCreateInfoKHR.Buffer self()

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

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

the value of the VkXcbSurfaceCreateInfoKHR#sType field.

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

Sets the specified value to the VkXcbSurfaceCreateInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_XCB_SURFACE_CREATE_INFO_KHR value to the VkXcbSurfaceCreateInfoKHR#sType field.

windowback to summary
public int window()
Returns:int

the value of the VkXcbSurfaceCreateInfoKHR#window field.

Annotations
@NativeType:xcb_window_t
windowback to summary
public VkXcbSurfaceCreateInfoKHR.Buffer window(int value)

Sets the specified value to the VkXcbSurfaceCreateInfoKHR#window field.