Package org.lwjgl.vulkan

Class VkWin32SurfaceCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkWin32SurfaceCreateInfoKHR>

org.lwjgl.vulkan.VkWin32SurfaceCreateInfoKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkWin32SurfaceCreateInfoKHR
extends Struct<VkWin32SurfaceCreateInfoKHR>
implements NativeResource

Structure specifying parameters of a newly created Win32 surface object.

Valid Usage

• hinstance must be a valid Win32 HINSTANCE
• hwnd must be a valid Win32 HWND

Valid Usage (Implicit)

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

See Also

CreateWin32SurfaceKHR

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkWin32SurfaceCreateInfoKHR.Buffer	An array of VkWin32SurfaceCreateInfoKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	HINSTANCE	The struct member offsets.
static final int	HWND	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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkWin32SurfaceCreateInfoKHR(ByteBuffer container)	Creates a VkWin32SurfaceCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkWin32SurfaceCreateInfoKHR	calloc()	Returns a new VkWin32SurfaceCreateInfoKHR instance allocated with memCalloc.
static VkWin32SurfaceCreateInfoKHR.Buffer	calloc(int capacity)	Returns a new VkWin32SurfaceCreateInfoKHR.Buffer instance allocated with memCalloc.
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.
static VkWin32SurfaceCreateInfoKHR	calloc(MemoryStack stack)	Returns a new VkWin32SurfaceCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkWin32SurfaceCreateInfoKHR	callocStack()	Deprecated.
static VkWin32SurfaceCreateInfoKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkWin32SurfaceCreateInfoKHR.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkWin32SurfaceCreateInfoKHR	callocStack(MemoryStack stack)	Deprecated.
static VkWin32SurfaceCreateInfoKHR	create()	Returns a new VkWin32SurfaceCreateInfoKHR instance allocated with BufferUtils.
static VkWin32SurfaceCreateInfoKHR.Buffer	create(int capacity)	Returns a new VkWin32SurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.
static VkWin32SurfaceCreateInfoKHR	create(long address)	Returns a new VkWin32SurfaceCreateInfoKHR instance for the specified memory address.
static VkWin32SurfaceCreateInfoKHR.Buffer	create(long address, int capacity)	Create a VkWin32SurfaceCreateInfoKHR.Buffer instance at the specified memory.
static VkWin32SurfaceCreateInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static VkWin32SurfaceCreateInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	reserved for future use.
VkWin32SurfaceCreateInfoKHR	flags(int value)	Sets the specified value to the flags() field.
long	hinstance()	the Win32 HINSTANCE for the window to associate the surface with.
VkWin32SurfaceCreateInfoKHR	hinstance(long value)	Sets the specified value to the hinstance() field.
long	hwnd()	the Win32 HWND for the window to associate the surface with.
VkWin32SurfaceCreateInfoKHR	hwnd(long value)	Sets the specified value to the hwnd() field.
static VkWin32SurfaceCreateInfoKHR	malloc()	Returns a new VkWin32SurfaceCreateInfoKHR instance allocated with memAlloc.
static VkWin32SurfaceCreateInfoKHR.Buffer	malloc(int capacity)	Returns a new VkWin32SurfaceCreateInfoKHR.Buffer instance allocated with memAlloc.
static VkWin32SurfaceCreateInfoKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkWin32SurfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkWin32SurfaceCreateInfoKHR	malloc(MemoryStack stack)	Returns a new VkWin32SurfaceCreateInfoKHR instance allocated on the specified MemoryStack.
static VkWin32SurfaceCreateInfoKHR	mallocStack()	Deprecated.
static VkWin32SurfaceCreateInfoKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkWin32SurfaceCreateInfoKHR.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkWin32SurfaceCreateInfoKHR	mallocStack(MemoryStack stack)	Deprecated.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static long	nhinstance(long struct)	Unsafe version of hinstance().
static void	nhinstance(long struct, long value)	Unsafe version of hinstance.
static long	nhwnd(long struct)	Unsafe version of hwnd().
static void	nhwnd(long struct, long value)	Unsafe version of hwnd.
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkWin32SurfaceCreateInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkWin32SurfaceCreateInfoKHR	set(int sType, long pNext, int flags, long hinstance, long hwnd)	Initializes this struct with the specified values.
VkWin32SurfaceCreateInfoKHR	set(VkWin32SurfaceCreateInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkWin32SurfaceCreateInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkWin32SurfaceCreateInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

HINSTANCE

public static final int HINSTANCE

The struct member offsets.

HWND

public static final int HWND

The struct member offsets.

Constructor Details

VkWin32SurfaceCreateInfoKHR

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkWin32SurfaceCreateInfoKHR>

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.

hinstance

public long hinstance()

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

hwnd

public long hwnd()

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

sType

public VkWin32SurfaceCreateInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkWin32SurfaceCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR value to the sType() field.

pNext

public VkWin32SurfaceCreateInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkWin32SurfaceCreateInfoKHR flags(int value)

Sets the specified value to the flags() field.

hinstance

public VkWin32SurfaceCreateInfoKHR hinstance(long value)

Sets the specified value to the hinstance() field.

hwnd

public VkWin32SurfaceCreateInfoKHR hwnd(long value)

Sets the specified value to the hwnd() field.

set

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

Initializes this struct with the specified values.

set

public VkWin32SurfaceCreateInfoKHR set(VkWin32SurfaceCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkWin32SurfaceCreateInfoKHR malloc()

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

calloc

public static VkWin32SurfaceCreateInfoKHR calloc()

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

create

public static VkWin32SurfaceCreateInfoKHR create()

Returns a new VkWin32SurfaceCreateInfoKHR instance allocated with BufferUtils.

create

public static VkWin32SurfaceCreateInfoKHR create(long address)

Returns a new VkWin32SurfaceCreateInfoKHR instance for the specified memory address.

createSafe

@Nullable
public static VkWin32SurfaceCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkWin32SurfaceCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkWin32SurfaceCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkWin32SurfaceCreateInfoKHR.Buffer create(int capacity)

Returns a new VkWin32SurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkWin32SurfaceCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkWin32SurfaceCreateInfoKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkWin32SurfaceCreateInfoKHR callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkWin32SurfaceCreateInfoKHR mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkWin32SurfaceCreateInfoKHR callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkWin32SurfaceCreateInfoKHR.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkWin32SurfaceCreateInfoKHR.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkWin32SurfaceCreateInfoKHR malloc(MemoryStack stack)

Returns a new VkWin32SurfaceCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - 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().

nhinstance

public static long nhinstance(long struct)

Unsafe version of hinstance().

nhwnd

public static long nhwnd(long struct)

Unsafe version of hwnd().

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.

nhinstance

public static void nhinstance(long struct,
 long value)

Unsafe version of hinstance.

nhwnd

public static void nhwnd(long struct,
 long value)

Unsafe version of hwnd.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate