Note:UOculusXRPassthroughLayerComponentis deprecated as of Unreal Engine 5.6. For new projects, use persistent passthrough instead. The styling properties documented on this page apply to both approaches.
SetTextureOpacity.FLinearColor).EnableEdgeColor and SetEdgeRenderingColor.| Type | Description |
|---|---|
None | No color mapping |
Grayscale To Color | Maps grayscale values to custom colors |
Grayscale | Converts the image to grayscale |
Color Adjustment | Adjusts brightness, contrast, and saturation |
Color LUT | Applies a single color look-up table |
Interpolated Color LUT | Blends between two color look-up tables |
EnableColorMap, SetColorMapType, or ClearColorMap.| Property | Type | Default | Range |
|---|---|---|---|
Brightness | float | 0.0 | -1.0 to 1.0 |
Contrast | float | 0.0 | -1.0 to 1.0 |
Posterize | float | 0.0 | 0.0 to 1.0 |
SetColorMapControls (accepts contrast, brightness, and posterize parameters).SetBrightnessContrastSaturation (for Color Adjustment mode; for Grayscale modes, use SetColorMapControls from the section above).| Property | Type | Default |
|---|---|---|
Color Scale | FLinearColor | White |
Color Offset | FLinearColor | Black |
SetColorScaleAndOffset.| Property | Type | Default | Range | Description |
|---|---|---|---|---|
LUT Weight | float | 1.0 | 0.0 to 1.0 | Blend weight of the color LUT |
Color LUT Source | UOculusXRPassthroughColorLut* | — | — | The source color LUT |
Color LUT Target | UOculusXRPassthroughColorLut* | — | — | The target LUT (Interpolated Color LUT only) |
SetColorLUTSource, SetColorLUTTarget, SetColorLUTWeight, or RemoveColorLut.| Value | Description |
|---|---|
Underlay (default) | Renders behind virtual content |
Overlay | Renders in front of virtual content |
Note: Overlay mode is not recommended for new projects. Use Underlay instead.
SetLayerPlacement.BlueprintCallable methods on UOculusXRPassthroughLayerBase. These methods are available in both Blueprints and C++.| Method | Purpose |
|---|---|
SetTextureOpacity | Set passthrough opacity |
EnableEdgeColor | Enable or disable edge rendering |
SetEdgeRenderingColor | Set the edge rendering color |
EnableColorMap | Enable or disable color mapping |
SetColorMapType | Set the active color map type |
SetColorMapControls | Set contrast, brightness, and posterize |
SetBrightnessContrastSaturation | Set contrast, brightness, and saturation |
SetColorScaleAndOffset | Set color scale and color offset |
SetLayerPlacement | Set overlay or underlay placement |
SetColorLUTSource | Set the source color LUT |
SetColorLUTTarget | Set the target color LUT |
SetColorLUTWeight | Set the LUT blend weight |
RemoveColorLut | Remove the active color LUT |
ClearColorMap | Clear all color map settings |
Note: For a complete working implementation using these properties in Blueprints, see the Passthrough Sample on GitHub.