FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kLightSteps.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_LIGHT_STEPS_H
9 #define K_FIRESYNC_LIGHT_STEPS_H
10 
11 #include <kFireSync/Client/Light/Extensions/kLightExt.h>
12 
19 //typedef kLightExt kLightSteps; --forward-declared in kFsDef.x.h
20 
29 kFsFx(kStatus) kLightSteps_SetCount(kLightSteps extension, kSize count);
30 
38 kFsFx(kSize) kLightSteps_Count(kLightSteps extension);
39 
48 kFsFx(kStatus) kLightSteps_CountInfo(kLightSteps extension, kInfoSize* info);
49 
59 kFsFx(kStatus) kLightSteps_SetState(kLightSteps extension, kSize stepIndex, kSize stateIndex);
60 
69 kFsFx(kSize) kLightSteps_State(kLightSteps extension, kSize stepIndex);
70 
80 kFsFx(kStatus) kLightSteps_SetRepetitionCount(kLightSteps extension, kSize stepIndex, kSize count);
81 
90 kFsFx(kSize) kLightSteps_RepetitionCount(kLightSteps extension, kSize stepIndex);
91 
100 kFsFx(kStatus) kLightSteps_SetStyle(kLightSteps extension, kLightStepsStyle style);
101 
109 kFsFx(kLightStepsStyle) kLightSteps_Style(kLightSteps extension);
110 
119 kFsFx(kStatus) kLightSteps_StyleInfo(kLightSteps extension, kInfoBits* info);
120 
121 #include <kFireSync/Client/Light/Extensions/kLightSteps.x.h>
122 
123 #endif
kLightSteps::kLightSteps_State
kSize kLightSteps_State(kLightSteps extension, kSize stepIndex)
Gets the light state id (index) associated with the specified step index.
kInfoBits
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
kLightExt.h
Declares the kLightExt type.
kLightStepsStyle
Represents light steps style.
kLightSteps::kLightSteps_SetRepetitionCount
kStatus kLightSteps_SetRepetitionCount(kLightSteps extension, kSize stepIndex, kSize count)
Sets the repetition count associated with the specified step index.
kLightSteps::kLightSteps_Count
kSize kLightSteps_Count(kLightSteps extension)
Gets the number of steps (state/count pairs) defined by this extension.
kLightSteps::kLightSteps_RepetitionCount
kSize kLightSteps_RepetitionCount(kLightSteps extension, kSize stepIndex)
Gets the repetition count associated with the specified step index.
kLightSteps::kLightSteps_Style
kLightStepsStyle kLightSteps_Style(kLightSteps extension)
Gets the steps style.
kLightSteps::kLightSteps_StyleInfo
kStatus kLightSteps_StyleInfo(kLightSteps extension, kInfoBits *info)
Reports constraint and validity information for the Steps style setting.
kLightSteps
Represents parameters for a light step extension.
kLightSteps::kLightSteps_CountInfo
kStatus kLightSteps_CountInfo(kLightSteps extension, kInfoSize *info)
Reports constraint and validity information for the Count setting.
kLightSteps::kLightSteps_SetCount
kStatus kLightSteps_SetCount(kLightSteps extension, kSize count)
Sets the number of steps (state/count pairs) defined by this extension.
kLightSteps::kLightSteps_SetState
kStatus kLightSteps_SetState(kLightSteps extension, kSize stepIndex, kSize stateIndex)
Sets the light state id (index) associated with the specified step index.
kInfoSize
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:370
kLightSteps::kLightSteps_SetStyle
kStatus kLightSteps_SetStyle(kLightSteps extension, kLightStepsStyle style)
Sets the steps style.