Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkWin32SurfaceCreateInfoKHR

extends Struct<VkWin32SurfaceCreateInfoKHR>
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.windows.*

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

CreateWin32SurfaceKHR

Layout


struct VkWin32SurfaceCreateInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkWin32SurfaceCreateFlagsKHR flags;
    HINSTANCE hinstance;
    HWND hwnd;
}

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
FLAGS

The struct member offsets.

public static final int
HINSTANCE

The struct member offsets.

public static final int
HWND

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.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkWin32SurfaceCreateInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkWin32SurfaceCreateInfoKHR
calloc()

Returns a new VkWin32SurfaceCreateInfoKHR instance allocated with memCalloc.

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

Returns a new VkWin32SurfaceCreateInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkWin32SurfaceCreateInfoKHR
callocStack()

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

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

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

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

Returns a new VkWin32SurfaceCreateInfoKHR instance allocated with BufferUtils.

public static VkWin32SurfaceCreateInfoKHR
create(long address)

Returns a new VkWin32SurfaceCreateInfoKHR instance for the specified memory address.

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

Returns a new VkWin32SurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkWin32SurfaceCreateInfoKHR.Buffer instance at the specified memory.

public static VkWin32SurfaceCreateInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

reserved for future use.

public VkWin32SurfaceCreateInfoKHR
flags(int value)

Sets the specified value to the flags field.

public long
hinstance()

the Win32 HINSTANCE for the window to associate the surface with.

public VkWin32SurfaceCreateInfoKHR
hinstance(long value)

Sets the specified value to the hinstance field.

public long
hwnd()

the Win32 HWND for the window to associate the surface with.

public VkWin32SurfaceCreateInfoKHR
hwnd(long value)

Sets the specified value to the hwnd field.

public static VkWin32SurfaceCreateInfoKHR
malloc()

Returns a new VkWin32SurfaceCreateInfoKHR instance allocated with memAlloc.

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

Returns a new VkWin32SurfaceCreateInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkWin32SurfaceCreateInfoKHR instance allocated on the specified MemoryStack.

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

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

public static VkWin32SurfaceCreateInfoKHR
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
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
nhinstance(long struct)

Unsafe version of hinstance.

public static void
nhinstance(long struct, long value)

Unsafe version of hinstance.

public static long
nhwnd(long struct)

Unsafe version of hwnd.

public static void
nhwnd(long struct, long value)

Unsafe version of hwnd.

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 long
pNext()

NULL or a pointer to a structure extending this structure.

public VkWin32SurfaceCreateInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkWin32SurfaceCreateInfoKHR
set(int sType, long pNext, int flags, long hinstance, long hwnd)

Initializes this struct with the specified values.

public VkWin32SurfaceCreateInfoKHR

Returns:

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

Sets the specified value to the sType field.

public VkWin32SurfaceCreateInfoKHR
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

HINSTANCEback to summary
public static final int HINSTANCE

The struct member offsets.

HWNDback to summary
public static final int HWND

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.

Constructor Detail

VkWin32SurfaceCreateInfoKHRback to summary
protected VkWin32SurfaceCreateInfoKHR(long address, ByteBuffer container)
VkWin32SurfaceCreateInfoKHRback to summary
public VkWin32SurfaceCreateInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkWin32SurfaceCreateInfoKHR calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkWin32SurfaceCreateInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkWin32SurfaceCreateInfoKHR create(long address)

Returns a new VkWin32SurfaceCreateInfoKHR instance for the specified memory address.

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

Returns a new VkWin32SurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkWin32SurfaceCreateInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkWin32SurfaceCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkWin32SurfaceCreateInfoKHR.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:VkWin32SurfaceCreateFlagsKHR
flagsback to summary
public VkWin32SurfaceCreateInfoKHR flags(int value)

Sets the specified value to the flags field.

hinstanceback to summary
public long hinstance()

the Win32 HINSTANCE for the window to associate the surface with.

Annotations
@NativeType:HINSTANCE
hinstanceback to summary
public VkWin32SurfaceCreateInfoKHR hinstance(long value)

Sets the specified value to the hinstance field.

hwndback to summary
public long hwnd()

the Win32 HWND for the window to associate the surface with.

Annotations
@NativeType:HWND
hwndback to summary
public VkWin32SurfaceCreateInfoKHR hwnd(long value)

Sets the specified value to the hwnd field.

mallocback to summary
public static VkWin32SurfaceCreateInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkWin32SurfaceCreateInfoKHR malloc(MemoryStack stack)

Returns a new VkWin32SurfaceCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
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.

nhinstanceback to summary
public static long nhinstance(long struct)

Unsafe version of hinstance.

nhinstanceback to summary
public static void nhinstance(long struct, long value)

Unsafe version of hinstance.

nhwndback to summary
public static long nhwnd(long struct)

Unsafe version of hwnd.

nhwndback to summary
public static void nhwnd(long struct, long value)

Unsafe version of hwnd.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkWin32SurfaceCreateInfoKHR set(int sType, long pNext, int flags, long hinstance, long hwnd)

Initializes this struct with the specified values.

setback to summary
public VkWin32SurfaceCreateInfoKHR set(VkWin32SurfaceCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkWin32SurfaceCreateInfoKHR

the source struct

Returns:VkWin32SurfaceCreateInfoKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkWin32SurfaceCreateInfoKHR.Buffer

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

An array of VkWin32SurfaceCreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkWin32SurfaceCreateInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkWin32SurfaceCreateInfoKHR.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 int

Returns:

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

public VkWin32SurfaceCreateInfoKHR.Buffer
flags(int value)

Sets the specified value to the VkWin32SurfaceCreateInfoKHR#flags field.

protected VkWin32SurfaceCreateInfoKHR
public long

Returns:

the value of the VkWin32SurfaceCreateInfoKHR#hinstance field.
hinstance
()

public VkWin32SurfaceCreateInfoKHR.Buffer
hinstance(long value)

Sets the specified value to the VkWin32SurfaceCreateInfoKHR#hinstance field.

public long

Returns:

the value of the VkWin32SurfaceCreateInfoKHR#hwnd field.
hwnd
()

public VkWin32SurfaceCreateInfoKHR.Buffer
hwnd(long value)

Sets the specified value to the VkWin32SurfaceCreateInfoKHR#hwnd field.

public long

Returns:

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

public VkWin32SurfaceCreateInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkWin32SurfaceCreateInfoKHR#pNext field.

protected VkWin32SurfaceCreateInfoKHR.Buffer
public int

Returns:

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

public VkWin32SurfaceCreateInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkWin32SurfaceCreateInfoKHR#sType field.

public VkWin32SurfaceCreateInfoKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkWin32SurfaceCreateInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

flagsback to summary
public int flags()
Returns:int

the value of the VkWin32SurfaceCreateInfoKHR#flags field.

Annotations
@NativeType:VkWin32SurfaceCreateFlagsKHR
flagsback to summary
public VkWin32SurfaceCreateInfoKHR.Buffer flags(int value)

Sets the specified value to the VkWin32SurfaceCreateInfoKHR#flags field.

getElementFactoryback to summary
protected VkWin32SurfaceCreateInfoKHR getElementFactory()

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

Annotations
@Override
hinstanceback to summary
public long hinstance()
Returns:long

the value of the VkWin32SurfaceCreateInfoKHR#hinstance field.

Annotations
@NativeType:HINSTANCE
hinstanceback to summary
public VkWin32SurfaceCreateInfoKHR.Buffer hinstance(long value)

Sets the specified value to the VkWin32SurfaceCreateInfoKHR#hinstance field.

hwndback to summary
public long hwnd()
Returns:long

the value of the VkWin32SurfaceCreateInfoKHR#hwnd field.

Annotations
@NativeType:HWND
hwndback to summary
public VkWin32SurfaceCreateInfoKHR.Buffer hwnd(long value)

Sets the specified value to the VkWin32SurfaceCreateInfoKHR#hwnd field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkWin32SurfaceCreateInfoKHR#pNext field.

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

Sets the specified value to the VkWin32SurfaceCreateInfoKHR#pNext field.

selfback to summary
protected VkWin32SurfaceCreateInfoKHR.Buffer self()

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

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

the value of the VkWin32SurfaceCreateInfoKHR#sType field.

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

Sets the specified value to the VkWin32SurfaceCreateInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR value to the VkWin32SurfaceCreateInfoKHR#sType field.