Skip to content

Commit 6bcd0d6

Browse files
committed
Add a paragraph for the texture mask sesstings in outlines
1 parent 1e8fb8f commit 6bcd0d6

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed
2.56 MB
Loading

articles/remote-rendering/overview/features/outlines.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.custom: devx-track-csharp
1212

1313
Selected objects can be highlighted visually by adding outline rendering via the [Hierarchical state override component](../../overview/features/override-hierarchical-state.md). This chapter explains how global parameters for outline rendering are changed through the client API.
1414

15-
Outline properties are a global setting. All objects that use outline rendering will use the same setting - it isn't possible to use a per-object outline color.
15+
Outline properties are a global setting. All objects that use outline rendering use the same setting - it isn't possible to use a per-object outline color.
1616

1717
> [!NOTE]
1818
> The outline rendering effect can't be applied to point clouds.
@@ -26,9 +26,12 @@ Class `OutlineSettings` holds the settings related to global outline properties.
2626
| `Color` | Color4Ub | The color that is used for drawing the outline. The alpha portion is ignored. |
2727
| `PulseRateHz` | float | The rate at which the outline oscillates per second|
2828
| `PulseIntensity` | float | The intensity of the outline pulse effect. Must be between 0.0 for no pulsing and 1.0 for full pulsing. Intensity implicitly sets the minimum opacity of the outline as `MinOpacity = 1.0 - PulseIntensity`. |
29+
| `MaskTexture` | 2D texture | If specified, the color of the outline will be tinted by this texture. The texture is sampled in screen-space coordinates and various parameters (`MaskScale`, `MaskScaleToFit`, `MaskOffset`, `MaskScrollSpeed`, `MaskRotationCenter`, `MaskRotationAngle`, `MaskRotationSpeed`) affect the stretching, rotation, and scrolling of that mapping. This feature can be used to achieve effects like a color gradient or dashed outlines. See second example image below. |
2930

3031
![An object rendered three times with different outline parameters](./media/outlines.png) The effect of changing the `color` parameter from yellow (left) to magenta (center) and `pulseIntensity` from 0 to 0.8 (right).
3132

33+
![An object rendered two times showing distinct use cases for outline texture masks](./media/outlines-with-texture-mask.png) The effect of applying a mask texture to the outlines: Screen aligned color gradients (left) or dashed outlines simulated by using a tiling texture with stripes (right).
34+
3235
## Example
3336

3437
The following code shows an example for setting outline parameters via the API:
@@ -57,7 +60,7 @@ void SetOutlineParameters(ApiHandle<RenderingSession> session)
5760
5861
## Performance
5962
60-
Outline rendering may have a significant impact on rendering performance. This impact varies based on screen-space spatial relation between selected and non-selected objects for a given frame.
63+
Outline rendering may have a significant impact on rendering performance. This impact varies based on screen-space spatial relation between selected and nonselected objects for a given frame.
6164
6265
## API documentation
6366

0 commit comments

Comments
 (0)