FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kProjector.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_PROJECTOR_H
9 #define K_FIRESYNC_PROJECTOR_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kProjector; --forward-declared in kFsDef.x.h
22 
23 
35 
43 kFsFx(kSize) kProjector_Width(kProjector projector);
44 
52 kFsFx(kSize) kProjector_Height(kProjector projector);
53 
64 kFsFx(kSize) kProjector_Id(kProjector projector);
65 
74 kFsFx(kStatus) kProjector_Clear(kProjector projector, kSize stateCount);
75 
87 kFsFx(kStatus) kProjector_Enable(kProjector projector, kBool enable);
88 
96 kFsFx(kBool) kProjector_IsEnabled(kProjector projector);
97 
112 kFsFx(kBool) kProjector_IsConnected(kProjector projector);
113 
126 
135 
144 kFsFx(kStatus) kProjector_ControlInfo(kProjector projector, kInfoBits* info);
145 
157 kFsFx(kStatus) kProjector_SetControlId(kProjector projector, k32u id);
158 
166 kFsFx(k32u) kProjector_ControlId(kProjector projector);
167 
176 kFsFx(kStatus) kProjector_ControlIdInfo(kProjector projector, kInfo* info);
177 
188 kFsFx(kStatus) kProjector_AddState(kProjector projector, kProjectorState* state);
189 
199 
209 kFsFx(kStatus) kProjector_SwapStates(kProjector projector, kSize index0, kSize index1);
210 
218 kFsFx(kSize) kProjector_StateCount(kProjector projector);
219 
228 kFsFx(kStatus) kProjector_StateCountInfo(kProjector projector, kInfoSize* info);
229 
238 kFsFx(kProjectorState) kProjector_StateAt(kProjector projector, kSize index);
239 
251 kFsFx(kStatus) kProjector_AddExtension(kProjector projector, kType type, kProjectorExt* extension);
252 
261 kFsFx(kStatus) kProjector_DeleteExtension(kProjector projector, kProjectorExt extension);
262 
270 kFsFx(kSize) kProjector_ExtensionCount(kProjector projector);
271 
280 kFsFx(kProjectorExt) kProjector_ExtensionAt(kProjector projector, kSize index);
281 
295 
304 
314 
323 kFsFx(kStatus) kProjector_SetFrameCount(kProjector projector, kSize frameCount);
324 
332 kFsFx(kSize) kProjector_FrameCount(kProjector projector);
333 
342 kFsFx(kStatus) kProjector_FrameCountInfo(kProjector projector, kInfoSize* info);
343 
356 kFsFx(kStatus) kProjector_SetBitDepth(kProjector projector, kSize bitDepth);
357 
365 kFsFx(kSize) kProjector_BitDepth(kProjector projector);
366 
375 kFsFx(kStatus) kProjector_BitDepthInfo(kProjector projector, kInfoSize* info);
376 
386 kFsFx(k64u) kProjector_MinimumPeriod(kProjector projector);
387 
397 
406 
415 kFsFx(kStatus) kProjector_PatternModeInfo(kProjector projector, kInfoBits* info);
416 
426 kFsFx(kStatus) kProjector_SetPalette(kProjector projector, kSize index, k32u pixel);
427 
436 kFsFx(k32u) kProjector_Palette(kProjector projector, kSize index);
437 
447 kFsFx(kStatus) kProjector_PaletteInfo(kProjector projector, kSize index, kInfo32u* info);
448 
465 kFsFx(kStatus) kProjector_LoadPatterns(kProjector projector, kArray2 patterns);
466 
475 kFsFx(kStatus) kProjector_Stats(kProjector projector, kProjectorStats* stats);
476 
485 
486 kEndHeader()
487 
488 #include <kFireSync/Client/kProjector.x.h>
489 
490 #endif
kStatus kProjector_ControlInfo(kProjector projector, kInfoBits *info)
Reports constraint and validity information for the Control setting.
kStatus kProjector_SwapStates(kProjector projector, kSize index0, kSize index1)
Swaps the order of two states in the projector's state list.
kSize kProjector_Width(kProjector projector)
Gets the width of the projector dimension.
kStatus kProjector_StateCountInfo(kProjector projector, kInfoSize *info)
Reports constraint and validity information for the StateCount setting.
kSize kProjector_ExtensionCount(kProjector projector)
Gets the number of control extensions that have been configured.
kBool kProjector_IsEnabled(kProjector projector)
Reports whether the projector is currently enabled.
kProjectorExt kProjector_ExtensionAt(kProjector projector, kSize index)
Gets the control extension at the specified index.
kProjectorPatternMode kProjector_PatternMode(kProjector projector)
Reports the pattern format.
Represents projector control modes.
kStatus kProjector_SetControl(kProjector projector, kProjectorControl type)
Sets the control mode of the projector.
kSize kProjector_Height(kProjector projector)
Gets the height of the projector dimension.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:454
kStatus kProjector_Enable(kProjector projector, kBool enable)
Enables or disables the projector.
kStatus kProjector_SetPatternMode(kProjector projector, kProjectorPatternMode mode)
Sets the format of patterns.
Represents projector configuration.
kStatus kProjector_BitDepthInfo(kProjector projector, kInfoSize *info)
Reports constraint and validity information for the BitDepth setting.
kBool kProjector_IsAutoIntensityEnabled(kProjector projector)
Determines whether an auto intensity extension is enabled.
kStatus kProjector_SetPalette(kProjector projector, kSize index, k32u pixel)
Sets the output pixel value corresponding to the specified pattern input value (used in 2D_1BPP patte...
kSize kProjector_StateCount(kProjector projector)
Gets the number of states belonging to the projector.
kStatus kProjector_DeleteExtension(kProjector projector, kProjectorExt extension)
Destroys the specified projector control extension and removes it from the projector's extension list...
kStatus kProjector_AddState(kProjector projector, kProjectorState *state)
Creates and adds a new state with default values.
kStatus kProjector_PaletteInfo(kProjector projector, kSize index, kInfo32u *info)
Reports constraint and validity information for the Palette setting.
Essential declarations related to FireSync nodes.
kStatus kProjector_AddExtension(kProjector projector, kType type, kProjectorExt *extension)
Creates and adds a new projector control extension of the specified type.
kProjectorState kProjector_StateAt(kProjector projector, kSize index)
Gets the state at the specified index.
kBool kProjector_IsConnected(kProjector projector)
Reports whether a projector device is connected and communicating.
Represents supported projector device types.
kStatus kProjector_SetBitDepth(kProjector projector, kSize bitDepth)
Sets the projected pattern bit depth.
kSize kProjector_Id(kProjector projector)
Gets the id of the projector module.
kStatus kProjector_SetFrameCount(kProjector projector, kSize frameCount)
Sets the number of frames to project in a sequence.
kStatus kProjector_EnableDynamicFrameRate(kProjector projector, kBool enable)
Enables or disables dynamic frame rate for the projector.
Represents projector pattern modes.
kStatus kProjector_Stats(kProjector projector, kProjectorStats *stats)
Retrieve statistics.
kStatus kProjector_PatternModeInfo(kProjector projector, kInfoBits *info)
Reports constraint and validity information for the PatternMode setting.
k32u kProjector_ControlId(kProjector projector)
Gets the control source id for a projector.
Represents projector run-time statistics.
Definition: kNodeDef.h:981
kStatus kProjector_DeleteState(kProjector projector, kProjectorState state)
Destroys the specified state and removes it from the projector's state list.
kStatus kProjector_ControlIdInfo(kProjector projector, kInfo *info)
Reports constraint and validity information for the ControlId setting.
kSize kProjector_FrameCount(kProjector projector)
Gets the number of frames in a sequence.
k32u kProjector_Palette(kProjector projector, kSize index)
Gets the output pixel value corresponding to the specified pattern input value (used in 2D_1BPP patte...
kBool kProjector_IsDynamicFrameRateEnabled(kProjector projector)
Reports whether the dynamic frame rate is currently enabled.
kStatus kProjector_SetControlId(kProjector projector, k32u id)
Sets the control source id for a projector.
k64u kProjector_MinimumPeriod(kProjector projector)
Reports the time required by this projector to respond to an event.
kStatus kProjector_LoadPatterns(kProjector projector, kArray2 patterns)
Loads the image patterns to project.
kProjectorModel kProjector_Model(kProjector projector)
Gets the model of the projector.
kStatus kProjector_DynamicFrameRateInfo(kProjector projector, kInfoBool *info)
Reports constraint and validity information for the DynamicFrameRate setting.
Represents constraint and validity information for a 32-bit unsigned integer setting.
Definition: kInfo.h:79
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:295
Abstract base class for projector control extension parameters.
kProjectorControl kProjector_Control(kProjector projector)
Reports the control mode of the projector.
Represents a projector state configuration.
kStatus kProjector_Clear(kProjector projector, kSize stateCount)
Resets projector mode settings to defaults.
Represents constraint and validity information for a general setting.
Definition: kInfo.h:45
kStatus kProjector_FrameCountInfo(kProjector projector, kInfoSize *info)
Reports constraint and validity information for the FrameCount setting.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:403
kSize kProjector_BitDepth(kProjector projector)
Gets the projected pattern bit depth.