OpenXRCompositionLayer

public bool AlphaBlend { get; set; }

Enables composition using layer alpha; initially false. Transparent UI also needs viewport TransparentBg and an actually transparent UI background. The setter updates the native flag and fallback material without establishing visible headset output.

public Vector2I AndroidSurfaceSize { get; set; }

Requested Android surface pixel size, initially 1024×1024. Set positive components before obtaining the surface. Does not change LayerViewport.Size. Resizing an existing surface requires the Android swapchain-update extension; the getter reports the request, not an acknowledged producer size.

public bool EnableHolePunch { get; set; }

Enables hole-punch mesh/material behavior, initially false. Native composition requires negative SortOrder, for example -1; a nonnegative order produces a configuration warning. The flag alone establishes no correct occlusion. Fallback material depth-test behavior changes; pixels were not tested.

public OpenXRCompositionLayer.EyeVisibilityEnum EyeVisibility { get; set; }

Eyes receiving the native layer: Both by default, Left or Right. Neither an Entity visibility mask nor a viewport selector. Updates native Quad/Cylinder/Equirect state; equivalent ordinary mesh-fallback behavior is not established.

public SubViewport LayerViewport { get; set; }

Assigned SubViewport or null. A viewport cannot be used by multiple in-tree layers. Assignment changes WhenVisible/WhenParentVisible to Always with a warning; Disabled is not automatically repaired. A nonnull viewport is rejected while Android surface mode is enabled. The borrowed reference transfers no ownership; detach it before deleting a separately owned viewport.

public bool ProtectedContent { get; set; }

Protected-content request, initially false. Passed as an XR swapchain creation flag; set before creating the surface/swapchain. The getter reads the request, not protection status. It establishes no DRM or capture-prevention guarantee: verify support, creation errors and security on the target device.

public int SortOrder { get; set; }

Native composition order, initially 1: higher values appear in front. The main projection occupies 0; avoid equality with 0, which may conflict with it. Negative order places the layer behind the projection and is required for hole punching. Does not order an ordinary fallback mesh; neither GUI z-index nor physical distance.

public OpenXRCompositionLayer.Swizzle SwapchainStateAlphaSwizzle { get; set; }

Source of the output alpha channel when sampling the layer, initially Alpha. Choose Red, Green, Blue, Alpha, Zero or One; Zero/One supply constants. Changes sampler mapping, not source resource pixels; actual application depends on OpenXR sampler extensions. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public OpenXRCompositionLayer.Swizzle SwapchainStateBlueSwizzle { get; set; }

Source of the output blue channel when sampling the layer, initially Blue. Choose Red, Green, Blue, Alpha, Zero or One; Zero/One supply constants. Changes sampler mapping, not source resource pixels; actual application depends on OpenXR sampler extensions. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public Color SwapchainStateBorderColor { get; set; }

Out-of-texture sample color for ClampToBorder, initially transparent black Color(0,0,0,0). Does not recolor the viewport or UI background. Alpha visibility also depends on AlphaBlend and transparent content; setting this color alone does not establish transparent composition. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public OpenXRCompositionLayer.Swizzle SwapchainStateGreenSwizzle { get; set; }

Source of the output green channel when sampling the layer, initially Green. Choose Red, Green, Blue, Alpha, Zero or One; Zero/One supply constants. Changes sampler mapping, not source resource pixels; actual application depends on OpenXR sampler extensions. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public OpenXRCompositionLayer.Wrap SwapchainStateHorizontalWrap { get; set; }

Horizontal texture addressing, initially ClampToBorder. Repeat tiles, MirroredRepeat alternates direction, ClampToEdge extends the edge, and ClampToBorder uses BorderColor. OpenGL ES maps MirrorClampToEdge to ClampToEdge without mirroring. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public OpenXRCompositionLayer.Filter SwapchainStateMagFilter { get; set; }

Layer image magnification filter, initially Linear. Nearest uses hard pixel sampling; Linear interpolates. Cubic requires the corresponding graphics-extension support. Does not increase LayerViewport resolution. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public float SwapchainStateMaxAnisotropy { get; set; }

Requested maximum anisotropy, initially 1. Can improve oblique-surface sampling when supported by the compositor. Use a finite value >=1 within device limits. The setter even stores zero without validation; its getter establishes neither GPU validity nor application. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public OpenXRCompositionLayer.Filter SwapchainStateMinFilter { get; set; }

Layer image minification filter, initially Linear. Nearest keeps hard pixel sampling; Linear interpolates samples. Cubic is forwarded as a graphics-extension mode and needs device support. A stored enum does not confirm compositor application. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public OpenXRCompositionLayer.MipmapMode SwapchainStateMipmapMode { get; set; }

Mip-level selection for minification, initially Linear; Nearest and Disabled are also available. Does not generate mipmaps. Current Vulkan mapping forwards Disabled as Linear too: do not assume it disables mip selection on every backend. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public OpenXRCompositionLayer.Swizzle SwapchainStateRedSwizzle { get; set; }

Source of the output red channel when sampling the layer, initially Red. Choose Red, Green, Blue, Alpha, Zero or One; Zero/One supply constants. Changes sampler mapping, not source resource pixels; actual application depends on OpenXR sampler extensions. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public OpenXRCompositionLayer.Wrap SwapchainStateVerticalWrap { get; set; }

Vertical texture addressing, initially ClampToBorder. Controls sampling outside the texture, not surface or viewport height. OpenGL ES maps MirrorClampToEdge to ClampToEdge; equal stored enums need not produce equal backend imagery. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public bool UseAndroidSurface { get; set; }

Selects Android surface input instead of SubViewport, initially false. Enabling clears LayerViewport; disabling does not restore it, so assign it again. Requires Android and XR_FB_android_surface_swapchain_create. Successful flag assignment on Windows creates no surface and establishes no support.

public bool GetAlphaBlend();

Returns the stored value. Enables composition using layer alpha; initially false. Transparent UI also needs viewport TransparentBg and an actually transparent UI background. The setter updates the native flag and fallback material without establishing visible headset output.

public OpenXRCompositionLayer.Swizzle GetAlphaSwizzle();

Reads the stored request. Source of the output alpha channel when sampling the layer, initially Alpha. Choose Red, Green, Blue, Alpha, Zero or One; Zero/One supply constants. Changes sampler mapping, not source resource pixels; actual application depends on OpenXR sampler extensions. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public JavaObject GetAndroidSurface();

Returns the layer-held JavaObject for android.view.Surface, or null. On Android the getter may lazily create the surface; it is not a passive readiness query. Requires UseAndroidSurface and the corresponding OpenXR extension. Do not dispose the borrowed wrapper; stop the external producer before deleting the layer. Windows XR-off execution established only null.

public Vector2I GetAndroidSurfaceSize();

Reads the stored request. Requested Android surface pixel size, initially 1024×1024. Set positive components before obtaining the surface. Does not change LayerViewport.Size. Resizing an existing surface requires the Android swapchain-update extension; the getter reports the request, not an acknowledged producer size.

public OpenXRCompositionLayer.Swizzle GetBlueSwizzle();

Reads the stored request. Source of the output blue channel when sampling the layer, initially Blue. Choose Red, Green, Blue, Alpha, Zero or One; Zero/One supply constants. Changes sampler mapping, not source resource pixels; actual application depends on OpenXR sampler extensions. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public Color GetBorderColor();

Reads the stored request. Out-of-texture sample color for ClampToBorder, initially transparent black Color(0,0,0,0). Does not recolor the viewport or UI background. Alpha visibility also depends on AlphaBlend and transparent content; setting this color alone does not establish transparent composition. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public bool GetEnableHolePunch();

Returns the stored value. Enables hole-punch mesh/material behavior, initially false. Native composition requires negative SortOrder, for example -1; a nonnegative order produces a configuration warning. The flag alone establishes no correct occlusion. Fallback material depth-test behavior changes; pixels were not tested.

public OpenXRCompositionLayer.EyeVisibilityEnum GetEyeVisibility();

Reads the stored request. Eyes receiving the native layer: Both by default, Left or Right. Neither an Entity visibility mask nor a viewport selector. Updates native Quad/Cylinder/Equirect state; equivalent ordinary mesh-fallback behavior is not established.

public OpenXRCompositionLayer.Swizzle GetGreenSwizzle();

Reads the stored request. Source of the output green channel when sampling the layer, initially Green. Choose Red, Green, Blue, Alpha, Zero or One; Zero/One supply constants. Changes sampler mapping, not source resource pixels; actual application depends on OpenXR sampler extensions. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public OpenXRCompositionLayer.Wrap GetHorizontalWrap();

Reads the stored request. Horizontal texture addressing, initially ClampToBorder. Repeat tiles, MirroredRepeat alternates direction, ClampToEdge extends the edge, and ClampToBorder uses BorderColor. OpenGL ES maps MirrorClampToEdge to ClampToEdge without mirroring. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public SubViewport GetLayerViewport();

Returns the stored value. Assigned SubViewport or null. A viewport cannot be used by multiple in-tree layers. Assignment changes WhenVisible/WhenParentVisible to Always with a warning; Disabled is not automatically repaired. A nonnull viewport is rejected while Android surface mode is enabled. The borrowed reference transfers no ownership; detach it before deleting a separately owned viewport.

public OpenXRCompositionLayer.Filter GetMagFilter();

Reads the stored request. Layer image magnification filter, initially Linear. Nearest uses hard pixel sampling; Linear interpolates. Cubic requires the corresponding graphics-extension support. Does not increase LayerViewport resolution. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public float GetMaxAnisotropy();

Reads the stored request. Requested maximum anisotropy, initially 1. Can improve oblique-surface sampling when supported by the compositor. Use a finite value >=1 within device limits. The setter even stores zero without validation; its getter establishes neither GPU validity nor application. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public OpenXRCompositionLayer.Filter GetMinFilter();

Reads the stored request. Layer image minification filter, initially Linear. Nearest keeps hard pixel sampling; Linear interpolates samples. Cubic is forwarded as a graphics-extension mode and needs device support. A stored enum does not confirm compositor application. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public OpenXRCompositionLayer.MipmapMode GetMipmapMode();

Reads the stored request. Mip-level selection for minification, initially Linear; Nearest and Disabled are also available. Does not generate mipmaps. Current Vulkan mapping forwards Disabled as Linear too: do not assume it disables mip selection on every backend. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public OpenXRCompositionLayer.Swizzle GetRedSwizzle();

Reads the stored request. Source of the output red channel when sampling the layer, initially Red. Choose Red, Green, Blue, Alpha, Zero or One; Zero/One supply constants. Changes sampler mapping, not source resource pixels; actual application depends on OpenXR sampler extensions. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public int GetSortOrder();

Returns the stored value. Native composition order, initially 1: higher values appear in front. The main projection occupies 0; avoid equality with 0, which may conflict with it. Negative order places the layer behind the projection and is required for hole punching. Does not order an ordinary fallback mesh; neither GUI z-index nor physical distance.

public bool GetUseAndroidSurface();

Reads the stored request. Selects Android surface input instead of SubViewport, initially false. Enabling clears LayerViewport; disabling does not restore it, so assign it again. Requires Android and XR_FB_android_surface_swapchain_create. Successful flag assignment on Windows creates no surface and establishes no support.

public OpenXRCompositionLayer.Wrap GetVerticalWrap();

Reads the stored request. Vertical texture addressing, initially ClampToBorder. Controls sampling outside the texture, not surface or viewport height. OpenGL ES maps MirrorClampToEdge to ClampToEdge; equal stored enums need not produce equal backend imagery. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public Vector2 IntersectsRay(Vector3 origin, Vector3 direction);

Returns world-space ray intersection UV for the concrete layer shape; miss is Vector2(-1,-1). The base implementation always misses; shapes override it. Quad was tested with orthonormal transforms without scale/shear; UV Y points downward. Neither a physics/occlusion or visibility check nor GUI input dispatch. Validate the hit and convert UV to viewport pixels.

public bool IsNativelySupported();

Queries the concrete layer type through the current OpenXR API/extension. False without them; Quad needs no separate shape extension, whereas Cylinder/Equirect require their extensions. Use after session startup to select a path. True guarantees no working swapchain, assigned viewport, submitted layer or visible pixels; false does not prevent fallback.

public bool IsProtectedContent();

Reads the stored request. Protected-content request, initially false. Passed as an XR swapchain creation flag; set before creating the surface/swapchain. The getter reads the request, not protection status. It establishes no DRM or capture-prevention guarantee: verify support, creation errors and security on the target device.

public void SetAlphaBlend(bool enabled);

Stores configuration. Enables composition using layer alpha; initially false. Transparent UI also needs viewport TransparentBg and an actually transparent UI background. The setter updates the native flag and fallback material without establishing visible headset output.

public void SetAlphaSwizzle(OpenXRCompositionLayer.Swizzle mode);

Source of the output alpha channel when sampling the layer, initially Alpha. Choose Red, Green, Blue, Alpha, Zero or One; Zero/One supply constants. Changes sampler mapping, not source resource pixels; actual application depends on OpenXR sampler extensions. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public void SetAndroidSurfaceSize(Vector2I size);

Requested Android surface pixel size, initially 1024×1024. Set positive components before obtaining the surface. Does not change LayerViewport.Size. Resizing an existing surface requires the Android swapchain-update extension; the getter reports the request, not an acknowledged producer size.

public void SetBlueSwizzle(OpenXRCompositionLayer.Swizzle mode);

Source of the output blue channel when sampling the layer, initially Blue. Choose Red, Green, Blue, Alpha, Zero or One; Zero/One supply constants. Changes sampler mapping, not source resource pixels; actual application depends on OpenXR sampler extensions. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public void SetBorderColor(Color color);

Out-of-texture sample color for ClampToBorder, initially transparent black Color(0,0,0,0). Does not recolor the viewport or UI background. Alpha visibility also depends on AlphaBlend and transparent content; setting this color alone does not establish transparent composition. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public void SetEnableHolePunch(bool enable);

Stores configuration. Enables hole-punch mesh/material behavior, initially false. Native composition requires negative SortOrder, for example -1; a nonnegative order produces a configuration warning. The flag alone establishes no correct occlusion. Fallback material depth-test behavior changes; pixels were not tested.

public void SetEyeVisibility(OpenXRCompositionLayer.EyeVisibilityEnum eyeVisibility);

Eyes receiving the native layer: Both by default, Left or Right. Neither an Entity visibility mask nor a viewport selector. Updates native Quad/Cylinder/Equirect state; equivalent ordinary mesh-fallback behavior is not established.

public void SetGreenSwizzle(OpenXRCompositionLayer.Swizzle mode);

Source of the output green channel when sampling the layer, initially Green. Choose Red, Green, Blue, Alpha, Zero or One; Zero/One supply constants. Changes sampler mapping, not source resource pixels; actual application depends on OpenXR sampler extensions. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public void SetHorizontalWrap(OpenXRCompositionLayer.Wrap mode);

Horizontal texture addressing, initially ClampToBorder. Repeat tiles, MirroredRepeat alternates direction, ClampToEdge extends the edge, and ClampToBorder uses BorderColor. OpenGL ES maps MirrorClampToEdge to ClampToEdge without mirroring. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public void SetLayerViewport(SubViewport viewport);

Stores configuration. Assigned SubViewport or null. A viewport cannot be used by multiple in-tree layers. Assignment changes WhenVisible/WhenParentVisible to Always with a warning; Disabled is not automatically repaired. A nonnull viewport is rejected while Android surface mode is enabled. The borrowed reference transfers no ownership; detach it before deleting a separately owned viewport.

public void SetMagFilter(OpenXRCompositionLayer.Filter mode);

Layer image magnification filter, initially Linear. Nearest uses hard pixel sampling; Linear interpolates. Cubic requires the corresponding graphics-extension support. Does not increase LayerViewport resolution. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public void SetMaxAnisotropy(float value);

Requested maximum anisotropy, initially 1. Can improve oblique-surface sampling when supported by the compositor. Use a finite value >=1 within device limits. The setter even stores zero without validation; its getter establishes neither GPU validity nor application. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public void SetMinFilter(OpenXRCompositionLayer.Filter mode);

Layer image minification filter, initially Linear. Nearest keeps hard pixel sampling; Linear interpolates samples. Cubic is forwarded as a graphics-extension mode and needs device support. A stored enum does not confirm compositor application. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public void SetMipmapMode(OpenXRCompositionLayer.MipmapMode mode);

Mip-level selection for minification, initially Linear; Nearest and Disabled are also available. Does not generate mipmaps. Current Vulkan mapping forwards Disabled as Linear too: do not assume it disables mip selection on every backend. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public void SetProtectedContent(bool protectedContent);

Protected-content request, initially false. Passed as an XR swapchain creation flag; set before creating the surface/swapchain. The getter reads the request, not protection status. It establishes no DRM or capture-prevention guarantee: verify support, creation errors and security on the target device.

public void SetRedSwizzle(OpenXRCompositionLayer.Swizzle mode);

Source of the output red channel when sampling the layer, initially Red. Choose Red, Green, Blue, Alpha, Zero or One; Zero/One supply constants. Changes sampler mapping, not source resource pixels; actual application depends on OpenXR sampler extensions. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.

public void SetSortOrder(int order);

Stores configuration. Native composition order, initially 1: higher values appear in front. The main projection occupies 0; avoid equality with 0, which may conflict with it. Negative order places the layer behind the projection and is required for hole punching. Does not order an ordinary fallback mesh; neither GUI z-index nor physical distance.

public void SetUseAndroidSurface(bool enable);

Selects Android surface input instead of SubViewport, initially false. Enabling clears LayerViewport; disabling does not restore it, so assign it again. Requires Android and XR_FB_android_surface_swapchain_create. Successful flag assignment on Windows creates no surface and establishes no support.

public void SetVerticalWrap(OpenXRCompositionLayer.Wrap mode);

Vertical texture addressing, initially ClampToBorder. Controls sampling outside the texture, not surface or viewport height. OpenGL ES maps MirrorClampToEdge to ClampToEdge; equal stored enums need not produce equal backend imagery. Native application requires XR_FB_swapchain_update_state and the active Vulkan/OpenGL ES backend extension; without them it is not applied.