Class XrSwapchainStateSamplerVulkanFB
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
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)
- The
XR_FB_swapchain_update_state_vulkanextension must be enabled prior to usingXrSwapchainStateSamplerVulkanFB typemust beTYPE_SWAPCHAIN_STATE_SAMPLER_VULKAN_FBnextmust beNULLor a valid pointer to the next structure in a structure chainminFiltermust be a validVkFiltervaluemagFiltermust be a validVkFiltervaluemipmapModemust be a validVkSamplerMipmapModevaluewrapModeSmust be a validVkSamplerAddressModevaluewrapModeTmust be a validVkSamplerAddressModevalueswizzleRedmust be a validVkComponentSwizzlevalueswizzleGreenmust be a validVkComponentSwizzlevalueswizzleBluemust be a validVkComponentSwizzlevalueswizzleAlphamust be a validVkComponentSwizzlevalue
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 Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofXrSwapchainStateSamplerVulkanFBstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionXrSwapchainStateSamplerVulkanFB(ByteBuffer container) Creates aXrSwapchainStateSamplerVulkanFBinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionan RGBA color to be used as border texels.borderColor(Consumer<XrColor4f> consumer) Passes theborderColor()field to the specifiedConsumer.borderColor(XrColor4f value) Copies the specifiedXrColor4fto theborderColor()field.calloc()Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated withmemCalloc.calloc(int capacity) Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated withBufferUtils.create(int capacity) Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated withBufferUtils.create(long address) Returns a newXrSwapchainStateSamplerVulkanFBinstance for the specified memory address.create(long address, int capacity) Create aXrSwapchainStateSamplerVulkanFB.Bufferinstance at the specified memory.Downcasts the specifiedXrSwapchainStateBaseHeaderFBinstance toXrSwapchainStateSamplerVulkanFB.Downcasts the specifiedXrSwapchainStateBaseHeaderFB.Bufferinstance toXrSwapchainStateSamplerVulkanFB.Buffer.static @Nullable XrSwapchainStateSamplerVulkanFBcreateSafe(long address) static @Nullable XrSwapchainStateSamplerVulkanFB.BuffercreateSafe(long address, int capacity) inta valid VulkanVkFilter.magFilter(int value) Sets the specified value to themagFilter()field.malloc()Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated withmemAlloc.malloc(int capacity) Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated on the specifiedMemoryStack.floata valid float used to represent max anisotropy.maxAnisotropy(float value) Sets the specified value to themaxAnisotropy()field.inta valid VulkanVkFilter.minFilter(int value) Sets the specified value to theminFilter()field.inta valid VulkanVkSamplerMipmapMode.mipmapMode(int value) Sets the specified value to themipmapMode()field.static XrColor4fnborderColor(long struct) Unsafe version ofborderColor().static voidnborderColor(long struct, XrColor4f value) Unsafe version ofborderColor.longnext()NULLor a pointer to the next structure in a structure chain.next(long value) Sets the specified value to thenext()field.static intnmagFilter(long struct) Unsafe version ofmagFilter().static voidnmagFilter(long struct, int value) Unsafe version ofmagFilter.static floatnmaxAnisotropy(long struct) Unsafe version ofmaxAnisotropy().static voidnmaxAnisotropy(long struct, float value) Unsafe version ofmaxAnisotropy.static intnminFilter(long struct) Unsafe version ofminFilter().static voidnminFilter(long struct, int value) Unsafe version ofminFilter.static intnmipmapMode(long struct) Unsafe version ofmipmapMode().static voidnmipmapMode(long struct, int value) Unsafe version ofmipmapMode.static longnnext(long struct) Unsafe version ofnext().static voidnnext(long struct, long value) Unsafe version ofnext.static intnswizzleAlpha(long struct) Unsafe version ofswizzleAlpha().static voidnswizzleAlpha(long struct, int value) Unsafe version ofswizzleAlpha.static intnswizzleBlue(long struct) Unsafe version ofswizzleBlue().static voidnswizzleBlue(long struct, int value) Unsafe version ofswizzleBlue.static intnswizzleGreen(long struct) Unsafe version ofswizzleGreen().static voidnswizzleGreen(long struct, int value) Unsafe version ofswizzleGreen.static intnswizzleRed(long struct) Unsafe version ofswizzleRed().static voidnswizzleRed(long struct, int value) Unsafe version ofswizzleRed.static intntype(long struct) Unsafe version oftype().static voidntype(long struct, int value) Unsafe version oftype.static intnwrapModeS(long struct) Unsafe version ofwrapModeS().static voidnwrapModeS(long struct, int value) Unsafe version ofwrapModeS.static intnwrapModeT(long struct) Unsafe version ofwrapModeT().static voidnwrapModeT(long struct, int value) Unsafe version ofwrapModeT.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.Copies the specified struct data to this struct.intsizeof()inta valid VulkanVkComponentSwizzle.swizzleAlpha(int value) Sets the specified value to theswizzleAlpha()field.inta valid VulkanVkComponentSwizzle.swizzleBlue(int value) Sets the specified value to theswizzleBlue()field.inta valid VulkanVkComponentSwizzle.swizzleGreen(int value) Sets the specified value to theswizzleGreen()field.inta valid VulkanVkComponentSwizzle.swizzleRed(int value) Sets the specified value to theswizzleRed()field.inttype()theXrStructureTypeof this structure.type(int value) Sets the specified value to thetype()field.Sets theTYPE_SWAPCHAIN_STATE_SAMPLER_VULKAN_FBvalue to thetype()field.inta valid VulkanVkSamplerAddressMode.wrapModeS(int value) Sets the specified value to thewrapModeS()field.inta valid VulkanVkSamplerAddressMode.wrapModeT(int value) Sets the specified value to thewrapModeT()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
TYPE
public static final int TYPEThe struct member offsets. -
NEXT
public static final int NEXTThe struct member offsets. -
MINFILTER
public static final int MINFILTERThe struct member offsets. -
MAGFILTER
public static final int MAGFILTERThe struct member offsets. -
MIPMAPMODE
public static final int MIPMAPMODEThe struct member offsets. -
WRAPMODES
public static final int WRAPMODESThe struct member offsets. -
WRAPMODET
public static final int WRAPMODETThe struct member offsets. -
SWIZZLERED
public static final int SWIZZLEREDThe struct member offsets. -
SWIZZLEGREEN
public static final int SWIZZLEGREENThe struct member offsets. -
SWIZZLEBLUE
public static final int SWIZZLEBLUEThe struct member offsets. -
SWIZZLEALPHA
public static final int SWIZZLEALPHAThe struct member offsets. -
MAXANISOTROPY
public static final int MAXANISOTROPYThe struct member offsets. -
BORDERCOLOR
public static final int BORDERCOLORThe struct member offsets.
-
-
Constructor Details
-
XrSwapchainStateSamplerVulkanFB
Creates aXrSwapchainStateSamplerVulkanFBinstance at the current position of the specifiedByteBuffercontainer. 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()- Specified by:
sizeofin classorg.lwjgl.system.Struct<XrSwapchainStateSamplerVulkanFB>
-
type
public int type()theXrStructureTypeof this structure. -
next
public long next()NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension. -
minFilter
public int minFilter()a valid VulkanVkFilter. -
magFilter
public int magFilter()a valid VulkanVkFilter. -
mipmapMode
public int mipmapMode()a valid VulkanVkSamplerMipmapMode. -
wrapModeS
public int wrapModeS()a valid VulkanVkSamplerAddressMode. -
wrapModeT
public int wrapModeT()a valid VulkanVkSamplerAddressMode. -
swizzleRed
public int swizzleRed()a valid VulkanVkComponentSwizzle. -
swizzleGreen
public int swizzleGreen()a valid VulkanVkComponentSwizzle. -
swizzleBlue
public int swizzleBlue()a valid VulkanVkComponentSwizzle. -
swizzleAlpha
public int swizzleAlpha()a valid VulkanVkComponentSwizzle. -
maxAnisotropy
public float maxAnisotropy()a valid float used to represent max anisotropy. -
borderColor
an RGBA color to be used as border texels. -
type
Sets the specified value to thetype()field. -
type$Default
Sets theTYPE_SWAPCHAIN_STATE_SAMPLER_VULKAN_FBvalue to thetype()field. -
next
Sets the specified value to thenext()field. -
minFilter
Sets the specified value to theminFilter()field. -
magFilter
Sets the specified value to themagFilter()field. -
mipmapMode
Sets the specified value to themipmapMode()field. -
wrapModeS
Sets the specified value to thewrapModeS()field. -
wrapModeT
Sets the specified value to thewrapModeT()field. -
swizzleRed
Sets the specified value to theswizzleRed()field. -
swizzleGreen
Sets the specified value to theswizzleGreen()field. -
swizzleBlue
Sets the specified value to theswizzleBlue()field. -
swizzleAlpha
Sets the specified value to theswizzleAlpha()field. -
maxAnisotropy
Sets the specified value to themaxAnisotropy()field. -
borderColor
Copies the specifiedXrColor4fto theborderColor()field. -
borderColor
Passes theborderColor()field to the specifiedConsumer. -
set
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. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated withBufferUtils. -
create
Returns a newXrSwapchainStateSamplerVulkanFBinstance for the specified memory address. -
createSafe
-
create
Downcasts the specifiedXrSwapchainStateBaseHeaderFBinstance toXrSwapchainStateSamplerVulkanFB. -
malloc
Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aXrSwapchainStateSamplerVulkanFB.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable XrSwapchainStateSamplerVulkanFB.Buffer createSafe(long address, int capacity) -
create
public static XrSwapchainStateSamplerVulkanFB.Buffer create(XrSwapchainStateBaseHeaderFB.Buffer value) Downcasts the specifiedXrSwapchainStateBaseHeaderFB.Bufferinstance toXrSwapchainStateSamplerVulkanFB.Buffer. -
malloc
Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrSwapchainStateSamplerVulkanFB.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static XrSwapchainStateSamplerVulkanFB.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
ntype
public static int ntype(long struct) Unsafe version oftype(). -
nnext
public static long nnext(long struct) Unsafe version ofnext(). -
nminFilter
public static int nminFilter(long struct) Unsafe version ofminFilter(). -
nmagFilter
public static int nmagFilter(long struct) Unsafe version ofmagFilter(). -
nmipmapMode
public static int nmipmapMode(long struct) Unsafe version ofmipmapMode(). -
nwrapModeS
public static int nwrapModeS(long struct) Unsafe version ofwrapModeS(). -
nwrapModeT
public static int nwrapModeT(long struct) Unsafe version ofwrapModeT(). -
nswizzleRed
public static int nswizzleRed(long struct) Unsafe version ofswizzleRed(). -
nswizzleGreen
public static int nswizzleGreen(long struct) Unsafe version ofswizzleGreen(). -
nswizzleBlue
public static int nswizzleBlue(long struct) Unsafe version ofswizzleBlue(). -
nswizzleAlpha
public static int nswizzleAlpha(long struct) Unsafe version ofswizzleAlpha(). -
nmaxAnisotropy
public static float nmaxAnisotropy(long struct) Unsafe version ofmaxAnisotropy(). -
nborderColor
Unsafe version ofborderColor(). -
ntype
public static void ntype(long struct, int value) Unsafe version oftype. -
nnext
public static void nnext(long struct, long value) Unsafe version ofnext. -
nminFilter
public static void nminFilter(long struct, int value) Unsafe version ofminFilter. -
nmagFilter
public static void nmagFilter(long struct, int value) Unsafe version ofmagFilter. -
nmipmapMode
public static void nmipmapMode(long struct, int value) Unsafe version ofmipmapMode. -
nwrapModeS
public static void nwrapModeS(long struct, int value) Unsafe version ofwrapModeS. -
nwrapModeT
public static void nwrapModeT(long struct, int value) Unsafe version ofwrapModeT. -
nswizzleRed
public static void nswizzleRed(long struct, int value) Unsafe version ofswizzleRed. -
nswizzleGreen
public static void nswizzleGreen(long struct, int value) Unsafe version ofswizzleGreen. -
nswizzleBlue
public static void nswizzleBlue(long struct, int value) Unsafe version ofswizzleBlue. -
nswizzleAlpha
public static void nswizzleAlpha(long struct, int value) Unsafe version ofswizzleAlpha. -
nmaxAnisotropy
public static void nmaxAnisotropy(long struct, float value) Unsafe version ofmaxAnisotropy. -
nborderColor
Unsafe version ofborderColor.
-