Class XrVulkanInstanceCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrVulkanInstanceCreateInfoKHR>

org.lwjgl.openxr.XrVulkanInstanceCreateInfoKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class XrVulkanInstanceCreateInfoKHR
extends Struct<XrVulkanInstanceCreateInfoKHR>
implements NativeResource

struct XrVulkanInstanceCreateInfoKHR {
    XrStructureType type;
    void const * next;
    XrSystemId systemId;
    XrVulkanInstanceCreateFlagsKHR createFlags;
    PFN_vkGetInstanceProcAddr pfnGetInstanceProcAddr;
    VkInstanceCreateInfo const * vulkanCreateInfo;
    VkAllocationCallbacks const * vulkanAllocator;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CREATEFLAGS	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	PFNGETINSTANCEPROCADDR	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SYSTEMID	The struct member offsets.
static final int	TYPE	The struct member offsets.
static final int	VULKANALLOCATOR	The struct member offsets.
static final int	VULKANCREATEINFO	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrVulkanInstanceCreateInfoKHR	calloc()	Returns a new XrVulkanInstanceCreateInfoKHR instance allocated with memCalloc.
static XrVulkanInstanceCreateInfoKHR.Buffer	calloc(int capacity)	Returns a new XrVulkanInstanceCreateInfoKHR.Buffer instance allocated with memCalloc.
static XrVulkanInstanceCreateInfoKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new XrVulkanInstanceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVulkanInstanceCreateInfoKHR	calloc(MemoryStack stack)	Returns a new XrVulkanInstanceCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVulkanInstanceCreateInfoKHR	create()	Returns a new XrVulkanInstanceCreateInfoKHR instance allocated with BufferUtils.
static XrVulkanInstanceCreateInfoKHR.Buffer	create(int capacity)	Returns a new XrVulkanInstanceCreateInfoKHR.Buffer instance allocated with BufferUtils.
static XrVulkanInstanceCreateInfoKHR	create(long address)	Returns a new XrVulkanInstanceCreateInfoKHR instance for the specified memory address.
static XrVulkanInstanceCreateInfoKHR.Buffer	create(long address, int capacity)	Create a XrVulkanInstanceCreateInfoKHR.Buffer instance at the specified memory.
long	createFlags()
XrVulkanInstanceCreateInfoKHR	createFlags(long value)	Sets the specified value to the createFlags field.
static @Nullable XrVulkanInstanceCreateInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrVulkanInstanceCreateInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrVulkanInstanceCreateInfoKHR	malloc()	Returns a new XrVulkanInstanceCreateInfoKHR instance allocated with memAlloc.
static XrVulkanInstanceCreateInfoKHR.Buffer	malloc(int capacity)	Returns a new XrVulkanInstanceCreateInfoKHR.Buffer instance allocated with memAlloc.
static XrVulkanInstanceCreateInfoKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new XrVulkanInstanceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
static XrVulkanInstanceCreateInfoKHR	malloc(MemoryStack stack)	Returns a new XrVulkanInstanceCreateInfoKHR instance allocated on the specified MemoryStack.
static long	ncreateFlags(long struct)	Unsafe version of createFlags().
static void	ncreateFlags(long struct, long value)	Unsafe version of createFlags.
long	next()
XrVulkanInstanceCreateInfoKHR	next(long value)	Sets the specified value to the next field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static long	npfnGetInstanceProcAddr(long struct)	Unsafe version of pfnGetInstanceProcAddr().
static void	npfnGetInstanceProcAddr(long struct, long value)	Unsafe version of pfnGetInstanceProcAddr.
static long	nsystemId(long struct)	Unsafe version of systemId().
static void	nsystemId(long struct, long value)	Unsafe version of systemId.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
static @Nullable VkAllocationCallbacks	nvulkanAllocator(long struct)	Unsafe version of vulkanAllocator().
static void	nvulkanAllocator(long struct, @Nullable VkAllocationCallbacks value)	Unsafe version of vulkanAllocator.
static VkInstanceCreateInfo	nvulkanCreateInfo(long struct)	Unsafe version of vulkanCreateInfo().
static void	nvulkanCreateInfo(long struct, VkInstanceCreateInfo value)	Unsafe version of vulkanCreateInfo.
long	pfnGetInstanceProcAddr()
XrVulkanInstanceCreateInfoKHR	pfnGetInstanceProcAddr(long value)	Sets the specified value to the pfnGetInstanceProcAddr field.
XrVulkanInstanceCreateInfoKHR	set(int type, long next, long systemId, long createFlags, long pfnGetInstanceProcAddr, VkInstanceCreateInfo vulkanCreateInfo, @Nullable VkAllocationCallbacks vulkanAllocator)	Initializes this struct with the specified values.
XrVulkanInstanceCreateInfoKHR	set(XrVulkanInstanceCreateInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
long	systemId()
XrVulkanInstanceCreateInfoKHR	systemId(long value)	Sets the specified value to the systemId field.
int	type()
XrVulkanInstanceCreateInfoKHR	type(int value)	Sets the specified value to the type field.
XrVulkanInstanceCreateInfoKHR	type$Default()	Sets the TYPE_VULKAN_INSTANCE_CREATE_INFO_KHR value to the type field.
static void	validate(long struct)	Validates pointer members that should not be NULL.
@Nullable VkAllocationCallbacks	vulkanAllocator()
XrVulkanInstanceCreateInfoKHR	vulkanAllocator(@Nullable VkAllocationCallbacks value)	Sets the address of the specified VkAllocationCallbacks to the vulkanAllocator field.
VkInstanceCreateInfo	vulkanCreateInfo()
XrVulkanInstanceCreateInfoKHR	vulkanCreateInfo(VkInstanceCreateInfo value)	Sets the address of the specified VkInstanceCreateInfo to the vulkanCreateInfo field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

SYSTEMID

public static final int SYSTEMID

The struct member offsets.

CREATEFLAGS

public static final int CREATEFLAGS

The struct member offsets.

PFNGETINSTANCEPROCADDR

public static final int PFNGETINSTANCEPROCADDR

The struct member offsets.

VULKANCREATEINFO

public static final int VULKANCREATEINFO

The struct member offsets.

VULKANALLOCATOR

public static final int VULKANALLOCATOR

The struct member offsets.

Constructor Details

XrVulkanInstanceCreateInfoKHR

public XrVulkanInstanceCreateInfoKHR(ByteBuffer container)

Creates a XrVulkanInstanceCreateInfoKHR 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<XrVulkanInstanceCreateInfoKHR>

type

@NativeType("XrStructureType")
public int type()

Returns:

the value of the type field.

next

@NativeType("void const *")
public long next()

Returns:

the value of the next field.

systemId

@NativeType("XrSystemId")
public long systemId()

Returns:

the value of the systemId field.

createFlags

@NativeType("XrVulkanInstanceCreateFlagsKHR")
public long createFlags()

Returns:

the value of the createFlags field.

pfnGetInstanceProcAddr

@NativeType("PFN_vkGetInstanceProcAddr")
public long pfnGetInstanceProcAddr()

Returns:

the value of the pfnGetInstanceProcAddr field.

vulkanCreateInfo

@NativeType("VkInstanceCreateInfo const *")
public VkInstanceCreateInfo vulkanCreateInfo()

Returns:

a VkInstanceCreateInfo view of the struct pointed to by the vulkanCreateInfo field.

vulkanAllocator

@NativeType("VkAllocationCallbacks const *")
public @Nullable VkAllocationCallbacks vulkanAllocator()

Returns:

a VkAllocationCallbacks view of the struct pointed to by the vulkanAllocator field.

type

public XrVulkanInstanceCreateInfoKHR type(@NativeType("XrStructureType")
 int value)

Sets the specified value to the type field.

type$Default

public XrVulkanInstanceCreateInfoKHR type$Default()

Sets the TYPE_VULKAN_INSTANCE_CREATE_INFO_KHR value to the type field.

next

public XrVulkanInstanceCreateInfoKHR next(@NativeType("void const *")
 long value)

Sets the specified value to the next field.

systemId

public XrVulkanInstanceCreateInfoKHR systemId(@NativeType("XrSystemId")
 long value)

Sets the specified value to the systemId field.

createFlags

public XrVulkanInstanceCreateInfoKHR createFlags(@NativeType("XrVulkanInstanceCreateFlagsKHR")
 long value)

Sets the specified value to the createFlags field.

pfnGetInstanceProcAddr

public XrVulkanInstanceCreateInfoKHR pfnGetInstanceProcAddr(@NativeType("PFN_vkGetInstanceProcAddr")
 long value)

Sets the specified value to the pfnGetInstanceProcAddr field.

vulkanCreateInfo

public XrVulkanInstanceCreateInfoKHR vulkanCreateInfo(@NativeType("VkInstanceCreateInfo const *")
 VkInstanceCreateInfo value)

Sets the address of the specified VkInstanceCreateInfo to the vulkanCreateInfo field.

vulkanAllocator

public XrVulkanInstanceCreateInfoKHR vulkanAllocator(@NativeType("VkAllocationCallbacks const *")
 @Nullable VkAllocationCallbacks value)

Sets the address of the specified VkAllocationCallbacks to the vulkanAllocator field.

set

public XrVulkanInstanceCreateInfoKHR set(int type,
 long next,
 long systemId,
 long createFlags,
 long pfnGetInstanceProcAddr,
 VkInstanceCreateInfo vulkanCreateInfo,
 @Nullable VkAllocationCallbacks vulkanAllocator)

Initializes this struct with the specified values.

set

public XrVulkanInstanceCreateInfoKHR set(XrVulkanInstanceCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrVulkanInstanceCreateInfoKHR malloc()

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

calloc

public static XrVulkanInstanceCreateInfoKHR calloc()

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

create

public static XrVulkanInstanceCreateInfoKHR create()

Returns a new XrVulkanInstanceCreateInfoKHR instance allocated with BufferUtils.

create

public static XrVulkanInstanceCreateInfoKHR create(long address)

Returns a new XrVulkanInstanceCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable XrVulkanInstanceCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrVulkanInstanceCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrVulkanInstanceCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrVulkanInstanceCreateInfoKHR.Buffer create(int capacity)

Returns a new XrVulkanInstanceCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrVulkanInstanceCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static XrVulkanInstanceCreateInfoKHR malloc(MemoryStack stack)

Returns a new XrVulkanInstanceCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrVulkanInstanceCreateInfoKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrVulkanInstanceCreateInfoKHR.Buffer calloc(int capacity,
 MemoryStack stack)

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

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

nsystemId

public static long nsystemId(long struct)

Unsafe version of systemId().

ncreateFlags

public static long ncreateFlags(long struct)

Unsafe version of createFlags().

npfnGetInstanceProcAddr

public static long npfnGetInstanceProcAddr(long struct)

Unsafe version of pfnGetInstanceProcAddr().

nvulkanCreateInfo

public static VkInstanceCreateInfo nvulkanCreateInfo(long struct)

Unsafe version of vulkanCreateInfo().

nvulkanAllocator

public static @Nullable VkAllocationCallbacks nvulkanAllocator(long struct)

Unsafe version of vulkanAllocator().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

nsystemId

public static void nsystemId(long struct,
 long value)

Unsafe version of systemId.

ncreateFlags

public static void ncreateFlags(long struct,
 long value)

Unsafe version of createFlags.

npfnGetInstanceProcAddr

public static void npfnGetInstanceProcAddr(long struct,
 long value)

Unsafe version of pfnGetInstanceProcAddr.

nvulkanCreateInfo

public static void nvulkanCreateInfo(long struct,
 VkInstanceCreateInfo value)

Unsafe version of vulkanCreateInfo.

nvulkanAllocator

public static void nvulkanAllocator(long struct,
 @Nullable VkAllocationCallbacks value)

Unsafe version of vulkanAllocator.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate