Skip to content

Commit 94b7fe2

Browse files
matwillilaurenhughes
authored andcommitted
Merged PR 9907: [Lighting][ Misc fixes to Lighting documentation.
Removing uneeded methods and tweaking text in several places
1 parent d2f2481 commit 94b7fe2

55 files changed

Lines changed: 76 additions & 285 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: 0 additions & 19 deletions
This file was deleted.

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

Lines changed: 0 additions & 21 deletions
This file was deleted.

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,13 @@ public class LampArrayBitmapEffect : ILampArrayEffect
1313
Renders a series of images to selected lamp indexes on the device.
1414

1515
## -remarks
16-
Effect captures the Series of images by 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.
16+
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.
1717

1818
Best effort is done to create a 2D composition of requested lamps and scale up/down images.
1919

20+
Must be [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md) before can be played.
21+
22+
If a [LampArray](../windows.devices.lights/lamparray.md) is bound to a [LampArrayBitmapEffect](lamparraybitmapeffect.md) and it disconnects, progress of the effect continues as a no-op. No exception/error is thrown/returned.
2023
## -see-also
2124

2225
## -examples

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

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

1818
## -remarks
19-
Once the effect has been [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value is locked and is not possible to set the value.
19+
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.
2020

2121
## -see-also
2222

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ public LampArrayBitmapEffect.LampArrayBitmapEffect(LampArray lampArray, Int32[]
1010
# Windows.Devices.Lights.Effects.LampArrayBitmapEffect.LampArrayBitmapEffect
1111

1212
## -description
13-
Creates and initializes a new instance of the effect. Effect creation does not start the effect.
14-
13+
Creates and initializes a new instance of the effect.
1514
## -parameters
1615
### -param lampArray
1716
The [LampArray](../windows.devices.lights/lamparray.md) the effect is played on.
@@ -20,7 +19,7 @@ The [LampArray](../windows.devices.lights/lamparray.md) the effect is played on.
2019
Subset of lamp indexes that effect will apply to.
2120

2221
## -remarks
23-
22+
Effect creation does not start the effect.
2423
## -see-also
2524

2625
## -examples

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

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

21-
Once the effect has been [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value is locked and is not possible to set the value.
21+
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.
2222

2323
## -see-also
2424

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,14 @@ public Size SuggestedBitmapSize { get; }
1111

1212
## -description
1313
Gets the most suitable image size for the caller selected lamp indexes that results in minimal scaling/distortion.
14-
1514
## -property-value
1615
The image size.
17-
1816
## -remarks
17+
Images supplied to [UpdateBitmap](lamparraybitmaprequestedeventargs_updatebitmap_191710798.md) that are not of the suggested size will incur a small performance penalty when resizing internally.
18+
1919
It is possible for this size to change between releases, as the algorithm is refined; even for the same LampArray.
2020

2121
Callers must NOT take a dependency that a certain size is returned for a particular LampArray.
22-
2322
## -see-also
2423

2524
## -examples

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

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

1818
## -remarks
19-
Once the effect has been [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value is locked and is not possible to set the value.
19+
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.
2020

2121
## -see-also
2222

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

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

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

23-
Once the effect has been [Appended](lamparrayeffectplaylist_append_292269384.md) to a [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), the value is locked and is not possible to set the value.
23+
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.
2424

2525
## -see-also
2626

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Provides event data for the [BitmapRequested](lamparraybitmapeffect_bitmapreques
1515
## -remarks
1616
Cannot call any methods on the object given by the event handler, outside of the event handler.
1717

18-
No effect progress cannot continue until the event handler has returned, so ensure the minimal is spent within it.
18+
No effect progress can continue until the event handler has returned, so ensure the minimal time is spent within it. (e.g. do not load images from disk during the event handler).
1919

2020
## -see-also
2121

0 commit comments

Comments
 (0)