Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSwapchainCreateInfo

extends Struct<XrSwapchainCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Creation info for a swapchain.
Valid Usage (Implicit)
See Also

CreateSession, CreateSwapchain, EnumerateSwapchainFormats

Layout


struct XrSwapchainCreateInfo {
    XrStructureType type;
    void const * next;
    XrSwapchainCreateFlags createFlags;
    XrSwapchainUsageFlags usageFlags;
    int64_t format;
    uint32_t sampleCount;
    uint32_t width;
    uint32_t height;
    uint32_t faceCount;
    uint32_t arraySize;
    uint32_t mipCount;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XrSwapchainCreateInfo.Buffer

An array of XrSwapchainCreateInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ARRAYSIZE

The struct member offsets.

public static final int
CREATEFLAGS

The struct member offsets.

public static final int
FACECOUNT

The struct member offsets.

public static final int
FORMAT

The struct member offsets.

public static final int
HEIGHT

The struct member offsets.

public static final int
MIPCOUNT

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SAMPLECOUNT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

public static final int
USAGEFLAGS

The struct member offsets.

public static final int
WIDTH

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrSwapchainCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
arraySize()

the number of array layers in the image or 1 for a 2D image, must not be 0 or greater than the graphics API’s maximum limit.

public XrSwapchainCreateInfo
arraySize(int value)

Sets the specified value to the arraySize field.

public static XrSwapchainCreateInfo
calloc()

Returns a new XrSwapchainCreateInfo instance allocated with memCalloc.

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

Returns a new XrSwapchainCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSwapchainCreateInfo instance allocated with BufferUtils.

public static XrSwapchainCreateInfo
create(long address)

Returns a new XrSwapchainCreateInfo instance for the specified memory address.

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

Returns a new XrSwapchainCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a XrSwapchainCreateInfo.Buffer instance at the specified memory.

public long
createFlags()

a bitmask of XrSwapchainCreateFlagBits describing additional properties of the swapchain.

public XrSwapchainCreateInfo
createFlags(long value)

Sets the specified value to the createFlags field.

public static XrSwapchainCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
faceCount()

the number of faces, which can be either 6 (for cubemaps) or 1.

public XrSwapchainCreateInfo
faceCount(int value)

Sets the specified value to the faceCount field.

public long
format()

a graphics API-specific texture format identifier.

public XrSwapchainCreateInfo
format(long value)

Sets the specified value to the format field.

public int
height()

the height of the image, must not be 0 or greater than the graphics API’s maximum limit.

public XrSwapchainCreateInfo
height(int value)

Sets the specified value to the height field.

public static XrSwapchainCreateInfo
malloc()

Returns a new XrSwapchainCreateInfo instance allocated with memAlloc.

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

Returns a new XrSwapchainCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new XrSwapchainCreateInfo instance allocated on the specified MemoryStack.

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

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

public int
mipCount()

describes the number of levels of detail available for minified sampling of the image, must not be 0 or greater than the graphics API’s maximum limit.

public XrSwapchainCreateInfo
mipCount(int value)

Sets the specified value to the mipCount field.

public static int
narraySize(long struct)

Unsafe version of arraySize.

public static void
narraySize(long struct, int value)

Unsafe version of arraySize.

public static long
ncreateFlags(long struct)

Unsafe version of createFlags.

public static void
ncreateFlags(long struct, long value)

Unsafe version of createFlags.

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrSwapchainCreateInfo
next(long value)

Sets the specified value to the next field.

public XrSwapchainCreateInfo
next(XrSecondaryViewConfigurationSwapchainCreateInfoMSFT value)

Prepends the specified XrSecondaryViewConfigurationSwapchainCreateInfoMSFT value to the next chain.

public XrSwapchainCreateInfo
next(XrSwapchainCreateInfoFoveationFB value)

Prepends the specified XrSwapchainCreateInfoFoveationFB value to the next chain.

public XrSwapchainCreateInfo
next(XrVulkanSwapchainCreateInfoMETA value)

Prepends the specified XrVulkanSwapchainCreateInfoMETA value to the next chain.

public static int
nfaceCount(long struct)

Unsafe version of faceCount.

public static void
nfaceCount(long struct, int value)

Unsafe version of faceCount.

public static long
nformat(long struct)

Unsafe version of format.

public static void
nformat(long struct, long value)

Unsafe version of format.

public static int
nheight(long struct)

Unsafe version of height.

public static void
nheight(long struct, int value)

Unsafe version of height.

public static int
nmipCount(long struct)

Unsafe version of mipCount.

public static void
nmipCount(long struct, int value)

Unsafe version of mipCount.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
nsampleCount(long struct)

Unsafe version of sampleCount.

public static void
nsampleCount(long struct, int value)

Unsafe version of sampleCount.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public static long
nusageFlags(long struct)

Unsafe version of usageFlags.

public static void
nusageFlags(long struct, long value)

Unsafe version of usageFlags.

public static int
nwidth(long struct)

Unsafe version of width.

public static void
nwidth(long struct, int value)

Unsafe version of width.

public int
sampleCount()

the number of sub-data element samples in the image, must not be 0 or greater than the graphics API’s maximum limit.

public XrSwapchainCreateInfo
sampleCount(int value)

Sets the specified value to the sampleCount field.

public XrSwapchainCreateInfo
set(int type, long next, long createFlags, long usageFlags, long format, int sampleCount, int width, int height, int faceCount, int arraySize, int mipCount)

Initializes this struct with the specified values.

public XrSwapchainCreateInfo

Returns:

this struct
set(XrSwapchainCreateInfo
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
type()

the XrStructureType of this structure.

public XrSwapchainCreateInfo
type(int value)

Sets the specified value to the type field.

public XrSwapchainCreateInfo
type$Default()

Sets the TYPE_SWAPCHAIN_CREATE_INFO value to the type field.

public long
usageFlags()

a bitmask of XrSwapchainUsageFlagBits describing the intended usage of the swapchain’s images.

public XrSwapchainCreateInfo
usageFlags(long value)

Sets the specified value to the usageFlags field.

public int
width()

the width of the image, must not be 0 or greater than the graphics API’s maximum limit.

public XrSwapchainCreateInfo
width(int value)

Sets the specified value to the width field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate