Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSwapchainStateSamplerVulkanFB

extends Struct<XrSwapchainStateSamplerVulkanFB>
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.vulkan.*

Vulkan-specific swapchain sampler state structure.
Description

When XrSwapchainStateSamplerVulkanFB is specified in the call to UpdateSwapchainFB, texture sampler state for all images in the XrSwapchain will be updated for the compositor process. For most cases, the sampler state update is only required compositor-side, as that is where the swapchain images are sampled. If the application requires sampling of the swapchain images, the application will be responsible for updating the texture state using normal Vulkan mechanisms and synchronizing appropriately with application-side rendering.

When XrSwapchainStateSamplerVulkanFB is specified in the call to GetSwapchainStateFB, the sampler state will be populated with the current swapchain sampler state.

To use XrSwapchainStateSamplerVulkanFB, USE_GRAPHICS_API_VULKAN must be defined before including openxr_platform.h.

Valid Usage (Implicit)
See Also

XrColor4f, GetSwapchainStateFB, UpdateSwapchainFB

Layout


struct XrSwapchainStateSamplerVulkanFB {
    XrStructureType type;
    void * next;
    VkFilter minFilter;
    VkFilter magFilter;
    VkSamplerMipmapMode mipmapMode;
    VkSamplerAddressMode wrapModeS;
    VkSamplerAddressMode wrapModeT;
    VkComponentSwizzle swizzleRed;
    VkComponentSwizzle swizzleGreen;
    VkComponentSwizzle swizzleBlue;
    VkComponentSwizzle swizzleAlpha;
    float maxAnisotropy;
    XrColor4f borderColor;
}

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
BORDERCOLOR

The struct member offsets.

public static final int
MAGFILTER

The struct member offsets.

public static final int
MAXANISOTROPY

The struct member offsets.

public static final int
MINFILTER

The struct member offsets.

public static final int
MIPMAPMODE

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SWIZZLEALPHA

The struct member offsets.

public static final int
SWIZZLEBLUE

The struct member offsets.

public static final int
SWIZZLEGREEN

The struct member offsets.

public static final int
SWIZZLERED

The struct member offsets.

public static final int
TYPE

The struct member offsets.

public static final int
WRAPMODES

The struct member offsets.

public static final int
WRAPMODET

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
XrSwapchainStateSamplerVulkanFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public XrColor4f
borderColor()

an RGBA color to be used as border texels.

public XrSwapchainStateSamplerVulkanFB
borderColor(XrColor4f value)

Copies the specified XrColor4f to the borderColor field.

public XrSwapchainStateSamplerVulkanFB
borderColor(Consumer<XrColor4f> consumer)

Passes the borderColor field to the specified Consumer.

public static XrSwapchainStateSamplerVulkanFB
calloc()

Returns a new XrSwapchainStateSamplerVulkanFB instance allocated with memCalloc.

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

Returns a new XrSwapchainStateSamplerVulkanFB.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSwapchainStateSamplerVulkanFB instance allocated with BufferUtils.

public static XrSwapchainStateSamplerVulkanFB
create(long address)

Returns a new XrSwapchainStateSamplerVulkanFB instance for the specified memory address.

public static XrSwapchainStateSamplerVulkanFB
create(XrSwapchainStateBaseHeaderFB value)

Downcasts the specified XrSwapchainStateBaseHeaderFB instance to XrSwapchainStateSamplerVulkanFB.

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

Returns a new XrSwapchainStateSamplerVulkanFB.Buffer instance allocated with BufferUtils.

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

Create a XrSwapchainStateSamplerVulkanFB.Buffer instance at the specified memory.

public static XrSwapchainStateSamplerVulkanFB.Buffer
create(XrSwapchainStateBaseHeaderFB.Buffer value)

Downcasts the specified XrSwapchainStateBaseHeaderFB.Buffer instance to XrSwapchainStateSamplerVulkanFB.Buffer.

public static XrSwapchainStateSamplerVulkanFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
magFilter()

a valid Vulkan VkFilter.

public XrSwapchainStateSamplerVulkanFB
magFilter(int value)

Sets the specified value to the magFilter field.

public static XrSwapchainStateSamplerVulkanFB
malloc()

Returns a new XrSwapchainStateSamplerVulkanFB instance allocated with memAlloc.

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

Returns a new XrSwapchainStateSamplerVulkanFB.Buffer instance allocated with memAlloc.

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

Returns a new XrSwapchainStateSamplerVulkanFB instance allocated on the specified MemoryStack.

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

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

public float
maxAnisotropy()

a valid float used to represent max anisotropy.

public XrSwapchainStateSamplerVulkanFB
maxAnisotropy(float value)

Sets the specified value to the maxAnisotropy field.

public int
minFilter()

a valid Vulkan VkFilter.

public XrSwapchainStateSamplerVulkanFB
minFilter(int value)

Sets the specified value to the minFilter field.

public int
mipmapMode()

a valid Vulkan VkSamplerMipmapMode.

public XrSwapchainStateSamplerVulkanFB
mipmapMode(int value)

Sets the specified value to the mipmapMode field.

public static XrColor4f
nborderColor(long struct)

Unsafe version of borderColor.

public static void
nborderColor(long struct, XrColor4f value)

Unsafe version of borderColor.

public long
next()

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

public XrSwapchainStateSamplerVulkanFB
next(long value)

Sets the specified value to the next field.

public static int
nmagFilter(long struct)

Unsafe version of magFilter.

public static void
nmagFilter(long struct, int value)

Unsafe version of magFilter.

public static float
nmaxAnisotropy(long struct)

Unsafe version of maxAnisotropy.

public static void
nmaxAnisotropy(long struct, float value)

Unsafe version of maxAnisotropy.

public static int
nminFilter(long struct)

Unsafe version of minFilter.

public static void
nminFilter(long struct, int value)

Unsafe version of minFilter.

public static int
nmipmapMode(long struct)

Unsafe version of mipmapMode.

public static void
nmipmapMode(long struct, int value)

Unsafe version of mipmapMode.

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

Unsafe version of swizzleAlpha.

public static void
nswizzleAlpha(long struct, int value)

Unsafe version of swizzleAlpha.

public static int
nswizzleBlue(long struct)

Unsafe version of swizzleBlue.

public static void
nswizzleBlue(long struct, int value)

Unsafe version of swizzleBlue.

public static int
nswizzleGreen(long struct)

Unsafe version of swizzleGreen.

public static void
nswizzleGreen(long struct, int value)

Unsafe version of swizzleGreen.

public static int
nswizzleRed(long struct)

Unsafe version of swizzleRed.

public static void
nswizzleRed(long struct, int value)

Unsafe version of swizzleRed.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public static int
nwrapModeS(long struct)

Unsafe version of wrapModeS.

public static void
nwrapModeS(long struct, int value)

Unsafe version of wrapModeS.

public static int
nwrapModeT(long struct)

Unsafe version of wrapModeT.

public static void
nwrapModeT(long struct, int value)

Unsafe version of wrapModeT.

public XrSwapchainStateSamplerVulkanFB
set(int type, long next, int minFilter, int magFilter, int mipmapMode, int wrapModeS, int wrapModeT, int swizzleRed, int swizzleGreen, int swizzleBlue, int swizzleAlpha, float maxAnisotropy, XrColor4f borderColor)

Initializes this struct with the specified values.

public XrSwapchainStateSamplerVulkanFB

Returns:

this struct
set
(XrSwapchainStateSamplerVulkanFB
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
swizzleAlpha()

a valid Vulkan VkComponentSwizzle.

public XrSwapchainStateSamplerVulkanFB
swizzleAlpha(int value)

Sets the specified value to the swizzleAlpha field.

public int
swizzleBlue()

a valid Vulkan VkComponentSwizzle.

public XrSwapchainStateSamplerVulkanFB
swizzleBlue(int value)

Sets the specified value to the swizzleBlue field.

public int
swizzleGreen()

a valid Vulkan VkComponentSwizzle.

public XrSwapchainStateSamplerVulkanFB
swizzleGreen(int value)

Sets the specified value to the swizzleGreen field.

public int
swizzleRed()

a valid Vulkan VkComponentSwizzle.

public XrSwapchainStateSamplerVulkanFB
swizzleRed(int value)

Sets the specified value to the swizzleRed field.

public int
type()

the XrStructureType of this structure.

public XrSwapchainStateSamplerVulkanFB
type(int value)

Sets the specified value to the type field.

public XrSwapchainStateSamplerVulkanFB
public int
wrapModeS()

a valid Vulkan VkSamplerAddressMode.

public XrSwapchainStateSamplerVulkanFB
wrapModeS(int value)

Sets the specified value to the wrapModeS field.

public int
wrapModeT()

a valid Vulkan VkSamplerAddressMode.

public XrSwapchainStateSamplerVulkanFB
wrapModeT(int value)

Sets the specified value to the wrapModeT field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate