Skip to content

Commit 9a42d8d

Browse files
Steven WhiteSteven White
authored andcommitted
Merged PR 15806: filling OGF gaps, and improving writing.
filling gaps, improving writing
1 parent c06fb61 commit 9a42d8d

50 files changed

Lines changed: 140 additions & 83 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎windows.devices.lights.effects/ilamparrayeffect.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ public interface ILampArrayEffect
1212

1313
## -description
1414

15+
The base interface for lamp array effects.
16+
1517
## -remarks
1618

1719
## -see-also
1820

19-
## -examples
20-
21+
## -examples

‎windows.devices.lights.effects/ilamparrayeffect_zindex.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,14 @@ public int ZIndex { get; set; }
1212

1313
## -description
1414

15+
Gets and sets the front-to-back z-index of a lamp array effect within a collection.
16+
1517
## -property-value
1618

19+
The front-to-back z-index of a lamp array effect within a collection.
20+
1721
## -remarks
1822

1923
## -see-also
2024

21-
## -examples
22-
25+
## -examples

‎windows.devices.lights.effects/lamparraybitmapeffect.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Renders a series of images to selected lamp indexes on the device.
1616
## -remarks
1717
Effect captures a series of images, by the caller subscribing to the [BitmapRequested](lamparraybitmapeffect_bitmaprequested.md) event and calling [UpdateBitmap](lamparraybitmaprequestedeventargs_updatebitmap_191710798.md) when triggered. This allows for images created on-the-fly to be supplied to the effect.
1818

19-
Best effort is done to create a 2D composition of requested lamps and scale up/down images.
19+
Best effort is made to create a 2D composition of requested lamps and scale up/down images.
2020

21-
Must be [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md) before can be played.
21+
Before you can play an effect, you must append it to a **LampArrayEffectPlaylist** (see [Append](lamparrayeffectplaylist_append_292269384.md)).
2222

2323
If a [LampArray](../windows.devices.lights/lamparray.md) is bound to a LampArrayBitmapEffect and it disconnects, progress of the effect continues as a no-op. No exception/error is thrown/returned.
2424
## -see-also

‎windows.devices.lights.effects/lamparraybitmapeffect_duration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Gets or sets the duration of the effect.
1717
Default value is 0.
1818

1919
## -remarks
20-
Once the effect has been [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value is locked and is no longer possible to set the value.
20+
After you've appended (see [Append](lamparrayeffectplaylist_append_292269384.md)) an effect to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value of this property is locked, and you can no longer change it.
2121

2222
## -see-also
2323

‎windows.devices.lights.effects/lamparraybitmapeffect_startdelay.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Default value is 0.
1919
## -remarks
2020
If within an [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), delay will be evaluated every time playlist repeats.
2121

22-
Once the effect has been [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value is locked and is no longer possible to set the value.
22+
After you've appended (see [Append](lamparrayeffectplaylist_append_292269384.md)) an effect to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value of this property is locked, and you can no longer change it.
2323

2424
## -see-also
2525

‎windows.devices.lights.effects/lamparraybitmapeffect_updateinterval.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Gets or sets the interval between the triggering of the [BitmapRequested](lampar
1717
Time interval between updates. Default value is 0.
1818

1919
## -remarks
20-
Once the effect has been [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value is locked and is no longer possible to set the value.
20+
After you've appended (see [Append](lamparrayeffectplaylist_append_292269384.md)) an effect to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value of this property is locked, and you can no longer change it.
2121

2222
## -see-also
2323

‎windows.devices.lights.effects/lamparraybitmapeffect_zindex.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Higher zIndex implies higher precedence.
2121

2222
If two effects with the same zIndex operate on the same lamp (via two separate [LampArrayEffectPlaylists](lamparrayeffectplaylist.md)), the behavior is undefined.
2323

24-
Once the effect has been [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value is locked and is no longer possible to set the value.
24+
After you've appended (see [Append](lamparrayeffectplaylist_append_292269384.md)) an effect to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value of this property is locked, and you can no longer change it.
2525

2626
## -see-also
2727

‎windows.devices.lights.effects/lamparrayblinkeffect.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Always starts from off/[Black](../windows.ui/colors_black.md), attacks to a defi
1818

1919
Will always set the state of lamp/s to off/[Black](../windows.ui/colors_black.md) when effect completes, regardless of progress.
2020

21-
Must be [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md) before can be played.
21+
Before you can play an effect, you must append it to a **LampArrayEffectPlaylist** (see [Append](lamparrayeffectplaylist_append_292269384.md)).
2222

23-
All lamps within the effect behave identically, subject to contraints of the lamp indexes (e.g. color channels). Best effort will always be done to accommodate lamp index constraints.
23+
All lamps within the effect behave identically, subject to contraints of the lamp indexes (for example, color channels). Best effort will always be done to accommodate lamp index constraints.
2424

2525
If a [LampArray](../windows.devices.lights/lamparray.md) is bound to a LampArrayBlinkEffect and it disconnects, progress of the effect continues as a no-op. No exception/error is thrown/returned.
2626

‎windows.devices.lights.effects/lamparrayblinkeffect_attackduration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Gets or sets the time spent attacking/ramping-up from off/[Black](../windows.ui/
1717
Default value is 0.
1818

1919
## -remarks
20-
Once the effect has been [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value is locked and is no longer possible to set the value.
20+
After you've appended (see [Append](lamparrayeffectplaylist_append_292269384.md)) an effect to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value of this property is locked, and you can no longer change it.
2121

2222
## -see-also
2323

‎windows.devices.lights.effects/lamparrayblinkeffect_color.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Gets or sets the color of peak intensity for the effect. Duration color is visib
1717
Default is [Black](../windows.ui/colors_black.md)
1818

1919
## -remarks
20-
Once the effect has been [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value is locked and is no longer possible to set the value.
20+
After you've appended (see [Append](lamparrayeffectplaylist_append_292269384.md)) an effect to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value of this property is locked, and you can no longer change it.
2121

2222
## -see-also
2323

0 commit comments

Comments
 (0)