Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkXlibSurfaceCreateInfoKHR

extends Struct<VkXlibSurfaceCreateInfoKHR>
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 Xlib surface object.
Valid Usage
Valid Usage (Implicit)
See Also

CreateXlibSurfaceKHR

Layout


struct VkXlibSurfaceCreateInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkXlibSurfaceCreateFlagsKHR flags;
    Display * dpy;
    Window 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
DPY

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
VkXlibSurfaceCreateInfoKHR(long address, ByteBuffer container)

public
VkXlibSurfaceCreateInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkXlibSurfaceCreateInfoKHR
calloc()

Returns a new VkXlibSurfaceCreateInfoKHR instance allocated with memCalloc.

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

Returns a new VkXlibSurfaceCreateInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkXlibSurfaceCreateInfoKHR
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkXlibSurfaceCreateInfoKHR
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 VkXlibSurfaceCreateInfoKHR
create()

Returns a new VkXlibSurfaceCreateInfoKHR instance allocated with BufferUtils.

public static VkXlibSurfaceCreateInfoKHR
create(long address)

Returns a new VkXlibSurfaceCreateInfoKHR instance for the specified memory address.

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

Returns a new VkXlibSurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkXlibSurfaceCreateInfoKHR.Buffer instance at the specified memory.

public static VkXlibSurfaceCreateInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
dpy()

a pointer to an Xlib Display connection to the X server.

public VkXlibSurfaceCreateInfoKHR
dpy(long value)

Sets the specified value to the dpy field.

public int
flags()

reserved for future use.

public VkXlibSurfaceCreateInfoKHR
flags(int value)

Sets the specified value to the flags field.

public static VkXlibSurfaceCreateInfoKHR
malloc()

Returns a new VkXlibSurfaceCreateInfoKHR instance allocated with memAlloc.

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

Returns a new VkXlibSurfaceCreateInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkXlibSurfaceCreateInfoKHR instance allocated on the specified MemoryStack.

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

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

public static VkXlibSurfaceCreateInfoKHR
mallocStack()

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

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

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

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

Unsafe version of dpy.

public static void
ndpy(long struct, long value)

Unsafe version of dpy.

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

Unsafe version of window.

public static void
nwindow(long struct, long value)

Unsafe version of window.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkXlibSurfaceCreateInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkXlibSurfaceCreateInfoKHR
set(int sType, long pNext, int flags, long dpy, long window)

Initializes this struct with the specified values.

public VkXlibSurfaceCreateInfoKHR

Returns:

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

Sets the specified value to the sType field.

public VkXlibSurfaceCreateInfoKHR
public long
window()

an Xlib Window to associate the surface with.

public VkXlibSurfaceCreateInfoKHR
window(long 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.

DPYback to summary
public static final int DPY

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

VkXlibSurfaceCreateInfoKHRback to summary
protected VkXlibSurfaceCreateInfoKHR(long address, ByteBuffer container)
VkXlibSurfaceCreateInfoKHRback to summary
public VkXlibSurfaceCreateInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkXlibSurfaceCreateInfoKHR calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkXlibSurfaceCreateInfoKHR.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 VkXlibSurfaceCreateInfoKHR 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 VkXlibSurfaceCreateInfoKHR create()

Returns a new VkXlibSurfaceCreateInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkXlibSurfaceCreateInfoKHR create(long address)

Returns a new VkXlibSurfaceCreateInfoKHR instance for the specified memory address.

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

Returns a new VkXlibSurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkXlibSurfaceCreateInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkXlibSurfaceCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
dpyback to summary
public long dpy()

a pointer to an Xlib Display connection to the X server.

Annotations
@NativeType:Display *
dpyback to summary
public VkXlibSurfaceCreateInfoKHR dpy(long value)

Sets the specified value to the dpy field.

flagsback to summary
public int flags()

reserved for future use.

Annotations
@NativeType:VkXlibSurfaceCreateFlagsKHR
flagsback to summary
public VkXlibSurfaceCreateInfoKHR flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkXlibSurfaceCreateInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkXlibSurfaceCreateInfoKHR malloc(MemoryStack stack)

Returns a new VkXlibSurfaceCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ndpyback to summary
public static long ndpy(long struct)

Unsafe version of dpy.

ndpyback to summary
public static void ndpy(long struct, long value)

Unsafe version of dpy.

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

Unsafe version of window.

nwindowback to summary
public static void nwindow(long struct, long 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 VkXlibSurfaceCreateInfoKHR pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkXlibSurfaceCreateInfoKHR set(int sType, long pNext, int flags, long dpy, long window)

Initializes this struct with the specified values.

setback to summary
public VkXlibSurfaceCreateInfoKHR set(VkXlibSurfaceCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkXlibSurfaceCreateInfoKHR

the source struct

Returns:VkXlibSurfaceCreateInfoKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_XLIB_SURFACE_CREATE_INFO_KHR value to the sType field.

windowback to summary
public long window()

an Xlib Window to associate the surface with.

Annotations
@NativeType:Window
windowback to summary
public VkXlibSurfaceCreateInfoKHR window(long value)

Sets the specified value to the window field.

org.lwjgl.vulkan back to summary

public Class VkXlibSurfaceCreateInfoKHR.Buffer

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

An array of VkXlibSurfaceCreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkXlibSurfaceCreateInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

public VkXlibSurfaceCreateInfoKHR.Buffer
dpy(long value)

Sets the specified value to the VkXlibSurfaceCreateInfoKHR#dpy field.

public int

Returns:

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

public VkXlibSurfaceCreateInfoKHR.Buffer
flags(int value)

Sets the specified value to the VkXlibSurfaceCreateInfoKHR#flags field.

protected VkXlibSurfaceCreateInfoKHR
public long

Returns:

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

public VkXlibSurfaceCreateInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkXlibSurfaceCreateInfoKHR#pNext field.

protected VkXlibSurfaceCreateInfoKHR.Buffer
public int

Returns:

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

public VkXlibSurfaceCreateInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkXlibSurfaceCreateInfoKHR#sType field.

public VkXlibSurfaceCreateInfoKHR.Buffer
public long

Returns:

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

public VkXlibSurfaceCreateInfoKHR.Buffer
window(long value)

Sets the specified value to the VkXlibSurfaceCreateInfoKHR#window field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkXlibSurfaceCreateInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

dpyback to summary
public long dpy()
Returns:long

the value of the VkXlibSurfaceCreateInfoKHR#dpy field.

Annotations
@NativeType:Display *
dpyback to summary
public VkXlibSurfaceCreateInfoKHR.Buffer dpy(long value)

Sets the specified value to the VkXlibSurfaceCreateInfoKHR#dpy field.

flagsback to summary
public int flags()
Returns:int

the value of the VkXlibSurfaceCreateInfoKHR#flags field.

Annotations
@NativeType:VkXlibSurfaceCreateFlagsKHR
flagsback to summary
public VkXlibSurfaceCreateInfoKHR.Buffer flags(int value)

Sets the specified value to the VkXlibSurfaceCreateInfoKHR#flags field.

getElementFactoryback to summary
protected VkXlibSurfaceCreateInfoKHR getElementFactory()

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

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

the value of the VkXlibSurfaceCreateInfoKHR#pNext field.

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

Sets the specified value to the VkXlibSurfaceCreateInfoKHR#pNext field.

selfback to summary
protected VkXlibSurfaceCreateInfoKHR.Buffer self()

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

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

the value of the VkXlibSurfaceCreateInfoKHR#sType field.

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

Sets the specified value to the VkXlibSurfaceCreateInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_XLIB_SURFACE_CREATE_INFO_KHR value to the VkXlibSurfaceCreateInfoKHR#sType field.

windowback to summary
public long window()
Returns:long

the value of the VkXlibSurfaceCreateInfoKHR#window field.

Annotations
@NativeType:Window
windowback to summary
public VkXlibSurfaceCreateInfoKHR.Buffer window(long value)

Sets the specified value to the VkXlibSurfaceCreateInfoKHR#window field.