Skip to content

Commit 320579d

Browse files
committed
Lighting API doc edit pass
1 parent 7133051 commit 320579d

105 files changed

Lines changed: 374 additions & 67 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/lamparraybitmapeffect.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ public class LampArrayBitmapEffect : ILampArrayEffect
1111

1212
## -description
1313
Renders a series of images to selected lamp indexes on the device.
14+
1415
## -remarks
15-
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 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.
1617

1718
Best effort is done to create a 2D composition of requested lamps and scale up/down images.
19+
1820
## -see-also
1921

2022
## -examples

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ public event TypedEventHandler BitmapRequested<LampArrayBitmapEffect, LampArrayB
1111

1212
## -description
1313
Event triggered by the system to indicate a new image should be supplied to the effect.
14+
1415
## -remarks
1516
- Once a playlist starts the effect, it will immediately trigger the `BitmapRequested` event.
16-
- If a playlist pauses the effect, it will temporarily stop further event triggers. Will resume when the playlist is started again.
17+
- If a playlist pauses the effect, it will temporarily stop further event triggers. Will resume when the playlist is started again.
1718
- If a playlist stops the effect, no further event triggers will occur until the playlist starts again.
18-
- The event will trigger a final time when the [Duration](lamparraybitmapeffect_duration.md) has expired. This should be used by the caller to set any final state before the effect completes.
19+
- The event will trigger a final time when the [Duration](lamparraybitmapeffect_duration.md) has expired. This should be used by the caller to set any final state before the effect completes.
1920

2021
Behavior of multiple handlers registered with this event is undefined.
22+
2123
## -see-also
2224

2325
## -examples

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,13 @@ public TimeSpan Duration { get; set; }
1111

1212
## -description
1313
Gets or sets the duration of the effect.
14+
1415
## -property-value
1516
Default value is 0.
17+
1618
## -remarks
1719
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.
20+
1821
## -see-also
1922

2023
## -examples

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,14 @@ public LampArrayBitmapEffect.LampArrayBitmapEffect(LampArray lampArray, Int32[]
1111

1212
## -description
1313
Creates and initializes a new instance of the effect. Effect creation does not start the effect.
14+
1415
## -parameters
1516
### -param lampArray
1617
The [LampArray](../windows.devices.lights/lamparray.md) the effect is played on.
18+
1719
### -param lampIndexes
1820
Subset of lamp indexes that effect will apply to.
21+
1922
## -remarks
2023

2124
## -see-also

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,15 @@ public TimeSpan StartDelay { get; set; }
1111

1212
## -description
1313
Gets or sets the duration to delay before starting the effect.
14+
1415
## -property-value
1516
Default value is 0.
17+
1618
## -remarks
1719
If within an [LampArrayEffectPlaylist](lamparrayeffectplaylist.md), delay will be evaluated every time playlist repeats.
1820

1921
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.
22+
2023
## -see-also
2124

2225
## -examples

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,15 @@ 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+
1415
## -property-value
16+
The image size.
1517

1618
## -remarks
1719
It is possible for this size to change between releases, as the algorithm is refined; even for the same LampArray.
1820

19-
Callers must NOT take a dependancy that a certain size is returned for a particular LampArray.
21+
Callers must NOT take a dependency that a certain size is returned for a particular LampArray.
22+
2023
## -see-also
2124

2225
## -examples

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,14 @@ public TimeSpan UpdateInterval { get; set; }
1010
# Windows.Devices.Lights.Effects.LampArrayBitmapEffect.UpdateInterval
1111

1212
## -description
13-
Gets or sets the interval between the triggering of the [BitmapRequested](lamparraybitmapeffect_bitmaprequested.md) event. The supplied image will be displayed until the event is next triggered.
13+
Gets or sets the interval between the triggering of the [BitmapRequested](lamparraybitmapeffect_bitmaprequested.md) event. The supplied image will be displayed until the event is next triggered.
14+
1415
## -property-value
15-
Default value is 0.
16+
Time interval between updates. Default value is 0.
17+
1618
## -remarks
1719
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.
20+
1821
## -see-also
1922

2023
## -examples

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,18 @@ public int ZIndex { get; set; }
1010
# Windows.Devices.Lights.Effects.LampArrayBitmapEffect.ZIndex
1111

1212
## -description
13-
Gets or sets the global precedence (across all playlists) for two effects that modify the same lamp (on the same [LampArray](../windows.devices.lights/lamparray.md))
13+
Gets or sets the global precedence (across all playlists) for two effects that modify the same lamp (on the same [LampArray](../windows.devices.lights/lamparray.md)).
14+
1415
## -property-value
1516
Default value is 0.
17+
1618
## -remarks
1719
Higher zIndex implies higher precedence.
1820

19-
If two effects with the same zIndex operate on the same lamp (via two seperate [LampArrayEffectPlaylists](lamparrayeffectplaylist.md)), the behaviour is undefined.
21+
If two effects with the same zIndex operate on the same lamp (via two seperate [LampArrayEffectPlaylists](lamparrayeffectplaylist.md)), the behavior is undefined.
2022

2123
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.
24+
2225
## -see-also
2326

2427
## -examples

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ public class LampArrayBitmapRequestedEventArgs
1111

1212
## -description
1313
Provides event data for the [BitmapRequested](lamparraybitmapeffect_bitmaprequested.md) event.
14+
1415
## -remarks
1516
Cannot call any methods on the object given by the event handler, outside of the event handler.
1617

1718
No effect progress cannot continue until the event handler has returned, so ensure the minimal is spent within it.
19+
1820
## -see-also
1921

2022
## -examples

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,13 @@ public TimeSpan SinceStarted { get; }
1111

1212
## -description
1313
Gets the time since the effect was started.
14+
1415
## -property-value
16+
Time value since the effect was started.
1517

1618
## -remarks
1719
Will always be 0 at the start of a playlist iteration.
20+
1821
## -see-also
1922

2023
## -examples

0 commit comments

Comments
 (0)