FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kLightState.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_LIGHT_STATE_H
9 #define K_FIRESYNC_LIGHT_STATE_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kLightState; --forward-declared in kFsDef.x.h
22 
23 
32 kFsFx(kSize) kLightState_Id(kLightState state);
33 
44 kFsFx(kStatus) kLightState_SetDelayNs(kLightState state, k64u delay);
45 
55 kFsFx(k64u) kLightState_DelayNs(kLightState state);
56 
65 kFsFx(kStatus) kLightState_DelayNsInfo(kLightState state, kInfo64u* info);
66 
77 kFsFx(kStatus) kLightState_SetExposureNs(kLightState state, k64u exposure);
78 
88 kFsFx(k64u) kLightState_ExposureNs(kLightState state);
89 
98 kFsFx(kStatus) kLightState_ExposureNsInfo(kLightState state, kInfo64u* info);
99 
110 kFsFx(kStatus) kLightState_SetGapNs(kLightState state, k64u gap);
111 
121 kFsFx(k64u) kLightState_GapNs(kLightState state);
122 
131 kFsFx(kStatus) kLightState_GapNsInfo(kLightState state, kInfo64u* info);
132 
142 kFsFx(k64u) kLightState_DurationNs(kLightState state);
143 
144 kEndHeader()
145 
146 #include <kFireSync/Client/kLightState.x.h>
147 
148 #endif
kLightState::kLightState_Id
kSize kLightState_Id(kLightState state)
Gets the id of the state.
kLightState::kLightState_GapNs
k64u kLightState_GapNs(kLightState state)
Gets the gap for the light state, in nanoseconds.
kLightState::kLightState_SetGapNs
kStatus kLightState_SetGapNs(kLightState state, k64u gap)
Sets the gap for the light state, in nanoseconds.
kLightState::kLightState_ExposureNsInfo
kStatus kLightState_ExposureNsInfo(kLightState state, kInfo64u *info)
Reports constraint and validity information for the ExposureNs setting.
kLightState
Represents a light state configuration.
kLightState::kLightState_SetExposureNs
kStatus kLightState_SetExposureNs(kLightState state, k64u exposure)
Sets the exposure for the light state, in nanoseconds.
kLightState::kLightState_SetDelayNs
kStatus kLightState_SetDelayNs(kLightState state, k64u delay)
Sets the delay for the light state, in nanoseconds.
kLightState::kLightState_DurationNs
k64u kLightState_DurationNs(kLightState state)
Reports the total time required to execute this light state, in nanoseconds.
kNodeDef.h
Essential declarations related to FireSync nodes.
kLightState::kLightState_GapNsInfo
kStatus kLightState_GapNsInfo(kLightState state, kInfo64u *info)
Reports constraint and validity information for the GapNs setting.
kInfo64u
Represents constraint and validity information for a 64-bit unsigned integer setting.
Definition: kInfo.h:187
kLightState::kLightState_ExposureNs
k64u kLightState_ExposureNs(kLightState state)
Gets the exposure for the light state, in nanoseconds.
kLightState::kLightState_DelayNsInfo
kStatus kLightState_DelayNsInfo(kLightState state, kInfo64u *info)
Reports constraint and validity information for the DelayNs setting, in nanoseconds.
kLightState::kLightState_DelayNs
k64u kLightState_DelayNs(kLightState state)
Gets the delay for the light state, in nanoseconds.