Class XrSwapchainStateSamplerVulkanFB
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrSwapchainStateSamplerVulkanFB
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrSwapchainStateSamplerVulkanFB extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceVulkan-specific swapchain sampler state structure.Description
When
XrSwapchainStateSamplerVulkanFBis specified in the call toUpdateSwapchainFB, texture sampler state for all images in theXrSwapchainwill 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
XrSwapchainStateSamplerVulkanFBis specified in the call toGetSwapchainStateFB, the sampler state will be populated with the current swapchain sampler state.To use
XrSwapchainStateSamplerVulkanFB,USE_GRAPHICS_API_VULKANmust be defined before includingopenxr_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,UpdateSwapchainFBLayout
struct XrSwapchainStateSamplerVulkanFB { XrStructureTypetype(); void *next(); VkFilterminFilter(); VkFiltermagFilter(); VkSamplerMipmapModemipmapMode(); VkSamplerAddressModewrapModeS(); VkSamplerAddressModewrapModeT(); VkComponentSwizzleswizzleRed(); VkComponentSwizzleswizzleGreen(); VkComponentSwizzleswizzleBlue(); VkComponentSwizzleswizzleAlpha(); floatmaxAnisotropy();XrColor4fborderColor(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrSwapchainStateSamplerVulkanFB.BufferAn array ofXrSwapchainStateSamplerVulkanFBstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intBORDERCOLOR
MAGFILTER
MAXANISOTROPY
MINFILTER
MIPMAPMODE
NEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSWIZZLEALPHA
SWIZZLEBLUE
SWIZZLEGREEN
SWIZZLERED
TYPE
WRAPMODES
WRAPMODETThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrSwapchainStateSamplerVulkanFB(java.nio.ByteBuffer container)Creates aXrSwapchainStateSamplerVulkanFBinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description XrColor4fborderColor()an RGBA color to be used as border texels.XrSwapchainStateSamplerVulkanFBborderColor(java.util.function.Consumer<XrColor4f> consumer)Passes theborderColor()field to the specifiedConsumer.XrSwapchainStateSamplerVulkanFBborderColor(XrColor4f value)Copies the specifiedXrColor4fto theborderColor()field.static XrSwapchainStateSamplerVulkanFBcalloc()Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated withmemCalloc.static XrSwapchainStateSamplerVulkanFB.Buffercalloc(int capacity)Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated withmemCalloc.static XrSwapchainStateSamplerVulkanFB.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrSwapchainStateSamplerVulkanFBcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrSwapchainStateSamplerVulkanFBcreate()Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated withBufferUtils.static XrSwapchainStateSamplerVulkanFB.Buffercreate(int capacity)Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated withBufferUtils.static XrSwapchainStateSamplerVulkanFBcreate(long address)Returns a newXrSwapchainStateSamplerVulkanFBinstance for the specified memory address.static XrSwapchainStateSamplerVulkanFB.Buffercreate(long address, int capacity)Create aXrSwapchainStateSamplerVulkanFB.Bufferinstance at the specified memory.static XrSwapchainStateSamplerVulkanFBcreate(XrSwapchainStateBaseHeaderFB value)Downcasts the specifiedXrSwapchainStateBaseHeaderFBinstance toXrSwapchainStateSamplerVulkanFB.static XrSwapchainStateSamplerVulkanFB.Buffercreate(XrSwapchainStateBaseHeaderFB.Buffer value)Downcasts the specifiedXrSwapchainStateBaseHeaderFB.Bufferinstance toXrSwapchainStateSamplerVulkanFB.Buffer.static XrSwapchainStateSamplerVulkanFBcreateSafe(long address)static XrSwapchainStateSamplerVulkanFB.BuffercreateSafe(long address, int capacity)intmagFilter()a valid VulkanVkFilter.XrSwapchainStateSamplerVulkanFBmagFilter(int value)Sets the specified value to themagFilter()field.static XrSwapchainStateSamplerVulkanFBmalloc()Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated withmemAlloc.static XrSwapchainStateSamplerVulkanFB.Buffermalloc(int capacity)Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated withmemAlloc.static XrSwapchainStateSamplerVulkanFB.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated on the specifiedMemoryStack.static XrSwapchainStateSamplerVulkanFBmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated on the specifiedMemoryStack.floatmaxAnisotropy()a valid float used to represent max anisotropy.XrSwapchainStateSamplerVulkanFBmaxAnisotropy(float value)Sets the specified value to themaxAnisotropy()field.intminFilter()a valid VulkanVkFilter.XrSwapchainStateSamplerVulkanFBminFilter(int value)Sets the specified value to theminFilter()field.intmipmapMode()a valid VulkanVkSamplerMipmapMode.XrSwapchainStateSamplerVulkanFBmipmapMode(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.XrSwapchainStateSamplerVulkanFBnext(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.XrSwapchainStateSamplerVulkanFBset(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.XrSwapchainStateSamplerVulkanFBset(XrSwapchainStateSamplerVulkanFB src)Copies the specified struct data to this struct.intsizeof()intswizzleAlpha()a valid VulkanVkComponentSwizzle.XrSwapchainStateSamplerVulkanFBswizzleAlpha(int value)Sets the specified value to theswizzleAlpha()field.intswizzleBlue()a valid VulkanVkComponentSwizzle.XrSwapchainStateSamplerVulkanFBswizzleBlue(int value)Sets the specified value to theswizzleBlue()field.intswizzleGreen()a valid VulkanVkComponentSwizzle.XrSwapchainStateSamplerVulkanFBswizzleGreen(int value)Sets the specified value to theswizzleGreen()field.intswizzleRed()a valid VulkanVkComponentSwizzle.XrSwapchainStateSamplerVulkanFBswizzleRed(int value)Sets the specified value to theswizzleRed()field.inttype()theXrStructureTypeof this structure.XrSwapchainStateSamplerVulkanFBtype(int value)Sets the specified value to thetype()field.XrSwapchainStateSamplerVulkanFBtype$Default()Sets theTYPE_SWAPCHAIN_STATE_SAMPLER_VULKAN_FBvalue to thetype()field.intwrapModeS()a valid VulkanVkSamplerAddressMode.XrSwapchainStateSamplerVulkanFBwrapModeS(int value)Sets the specified value to thewrapModeS()field.intwrapModeT()a valid VulkanVkSamplerAddressMode.XrSwapchainStateSamplerVulkanFBwrapModeT(int value)Sets the specified value to thewrapModeT()field.
-
-
-
Constructor Detail
-
XrSwapchainStateSamplerVulkanFB
public XrSwapchainStateSamplerVulkanFB(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
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, magFilter
public int minFilter() public int magFilter()
a valid VulkanVkFilter.
-
mipmapMode
public int mipmapMode()
a valid VulkanVkSamplerMipmapMode.
-
wrapModeS, wrapModeT
public int wrapModeS() public int wrapModeT()
a valid VulkanVkSamplerAddressMode.
-
swizzleRed, swizzleGreen, swizzleBlue, swizzleAlpha
public int swizzleRed() public int swizzleGreen() public int swizzleBlue() public int swizzleAlpha()
a valid VulkanVkComponentSwizzle.
-
maxAnisotropy
public float maxAnisotropy()
a valid float used to represent max anisotropy.
-
borderColor
public XrColor4f borderColor()
an RGBA color to be used as border texels.
-
type
public XrSwapchainStateSamplerVulkanFB type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrSwapchainStateSamplerVulkanFB type$Default()
Sets theTYPE_SWAPCHAIN_STATE_SAMPLER_VULKAN_FBvalue to thetype()field.
-
next
public XrSwapchainStateSamplerVulkanFB next(long value)
Sets the specified value to thenext()field.
-
minFilter
public XrSwapchainStateSamplerVulkanFB minFilter(int value)
Sets the specified value to theminFilter()field.
-
magFilter
public XrSwapchainStateSamplerVulkanFB magFilter(int value)
Sets the specified value to themagFilter()field.
-
mipmapMode
public XrSwapchainStateSamplerVulkanFB mipmapMode(int value)
Sets the specified value to themipmapMode()field.
-
wrapModeS
public XrSwapchainStateSamplerVulkanFB wrapModeS(int value)
Sets the specified value to thewrapModeS()field.
-
wrapModeT
public XrSwapchainStateSamplerVulkanFB wrapModeT(int value)
Sets the specified value to thewrapModeT()field.
-
swizzleRed
public XrSwapchainStateSamplerVulkanFB swizzleRed(int value)
Sets the specified value to theswizzleRed()field.
-
swizzleGreen
public XrSwapchainStateSamplerVulkanFB swizzleGreen(int value)
Sets the specified value to theswizzleGreen()field.
-
swizzleBlue
public XrSwapchainStateSamplerVulkanFB swizzleBlue(int value)
Sets the specified value to theswizzleBlue()field.
-
swizzleAlpha
public XrSwapchainStateSamplerVulkanFB swizzleAlpha(int value)
Sets the specified value to theswizzleAlpha()field.
-
maxAnisotropy
public XrSwapchainStateSamplerVulkanFB maxAnisotropy(float value)
Sets the specified value to themaxAnisotropy()field.
-
borderColor
public XrSwapchainStateSamplerVulkanFB borderColor(XrColor4f value)
Copies the specifiedXrColor4fto theborderColor()field.
-
borderColor
public XrSwapchainStateSamplerVulkanFB borderColor(java.util.function.Consumer<XrColor4f> consumer)
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
public XrSwapchainStateSamplerVulkanFB set(XrSwapchainStateSamplerVulkanFB src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrSwapchainStateSamplerVulkanFB malloc()
Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrSwapchainStateSamplerVulkanFB calloc()
Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrSwapchainStateSamplerVulkanFB create()
Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated withBufferUtils.
-
create
public static XrSwapchainStateSamplerVulkanFB create(long address)
Returns a newXrSwapchainStateSamplerVulkanFBinstance for the specified memory address.
-
createSafe
@Nullable public static XrSwapchainStateSamplerVulkanFB createSafe(long address)
-
create
public static XrSwapchainStateSamplerVulkanFB create(XrSwapchainStateBaseHeaderFB value)
Downcasts the specifiedXrSwapchainStateBaseHeaderFBinstance toXrSwapchainStateSamplerVulkanFB.
-
malloc
public static XrSwapchainStateSamplerVulkanFB.Buffer malloc(int capacity)
Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrSwapchainStateSamplerVulkanFB.Buffer calloc(int capacity)
Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrSwapchainStateSamplerVulkanFB.Buffer create(int capacity)
Returns a newXrSwapchainStateSamplerVulkanFB.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrSwapchainStateSamplerVulkanFB.Buffer create(long address, int capacity)
Create aXrSwapchainStateSamplerVulkanFB.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrSwapchainStateSamplerVulkanFB.Buffer createSafe(long address, int capacity)
-
create
public static XrSwapchainStateSamplerVulkanFB.Buffer create(XrSwapchainStateBaseHeaderFB.Buffer value)
Downcasts the specifiedXrSwapchainStateBaseHeaderFB.Bufferinstance toXrSwapchainStateSamplerVulkanFB.Buffer.
-
malloc
public static XrSwapchainStateSamplerVulkanFB malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrSwapchainStateSamplerVulkanFBinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrSwapchainStateSamplerVulkanFB calloc(org.lwjgl.system.MemoryStack stack)
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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
public static XrColor4f nborderColor(long struct)
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
public static void nborderColor(long struct, XrColor4f value)Unsafe version ofborderColor.
-
-