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 
19 //typedef kObject kProjector; --forward-declared in kFsDef.x.h
20 
31 
39 kFsFx(kSize) kProjector_Width(kProjector projector);
40 
48 kFsFx(kSize) kProjector_Height(kProjector projector);
49 
60 kFsFx(kSize) kProjector_Id(kProjector projector);
61 
70 kFsFx(kStatus) kProjector_Clear(kProjector projector, kSize stateCount);
71 
83 kFsFx(kStatus) kProjector_Enable(kProjector projector, kBool enable);
84 
92 kFsFx(kBool) kProjector_IsEnabled(kProjector projector);
93 
108 kFsFx(kBool) kProjector_IsConnected(kProjector projector);
109 
122 
131 
140 kFsFx(kStatus) kProjector_ControlInfo(kProjector projector, kInfoBits* info);
141 
153 kFsFx(kStatus) kProjector_SetControlId(kProjector projector, k32u id);
154 
162 kFsFx(k32u) kProjector_ControlId(kProjector projector);
163 
172 kFsFx(kStatus) kProjector_ControlIdInfo(kProjector projector, kInfo* info);
173 
184 kFsFx(kStatus) kProjector_AddState(kProjector projector, kProjectorState* state);
185 
195 
205 kFsFx(kStatus) kProjector_SwapStates(kProjector projector, kSize index0, kSize index1);
206 
214 kFsFx(kSize) kProjector_StateCount(kProjector projector);
215 
224 kFsFx(kStatus) kProjector_StateCountInfo(kProjector projector, kInfoSize* info);
225 
234 kFsFx(kProjectorState) kProjector_StateAt(kProjector projector, kSize index);
235 
247 kFsFx(kStatus) kProjector_AddExtension(kProjector projector, kType type, kProjectorExt* extension);
248 
257 kFsFx(kStatus) kProjector_DeleteExtension(kProjector projector, kProjectorExt extension);
258 
266 kFsFx(kSize) kProjector_ExtensionCount(kProjector projector);
267 
276 kFsFx(kProjectorExt) kProjector_ExtensionAt(kProjector projector, kSize index);
277 
292 
301 
311 
324 kFsFx(kStatus) kProjector_SetFrameCount(kProjector projector, kSize frameCount);
325 
333 kFsFx(kSize) kProjector_FrameCount(kProjector projector);
334 
343 kFsFx(kStatus) kProjector_FrameCountInfo(kProjector projector, kInfoSize* info);
344 
357 kFsFx(kStatus) kProjector_SetBitDepth(kProjector projector, kSize bitDepth);
358 
366 kFsFx(kSize) kProjector_BitDepth(kProjector projector);
367 
376 kFsFx(kStatus) kProjector_BitDepthInfo(kProjector projector, kInfoSize* info);
377 
385 kFsFx(k64u) kProjector_MinimumPeriod(kProjector projector);
386 
400 
410 
419 kFsFx(kStatus) kProjector_PatternModeInfo(kProjector projector, kInfoBits* info);
420 
435 kFsFx(kStatus) kProjector_SetPalette(kProjector projector, kSize index, k32u pixel);
436 
445 kFsFx(k32u) kProjector_Palette(kProjector projector, kSize index);
446 
456 kFsFx(kStatus) kProjector_PaletteInfo(kProjector projector, kSize index, kInfo32u* info);
457 
469 kFsFx(kStatus) kProjector_EnableLightOutput(kProjector projector, kBool enable);
470 
480 
489 kFsFx(kStatus) kProjector_LightOutputInfo(kProjector projector, kInfoBool* info);
490 
503 kFsFx(kStatus) kProjector_EnableAutoShutdown(kProjector projector, kBool enable);
504 
514 
524 
551 kFsFx(kStatus) kProjector_LoadPatterns(kProjector projector, kArray2 patterns);
552 
565 kFsFx(kStatus) kProjector_LoadRowGains(kProjector projector, kArray1 gains);
566 
579 kFsFx(kStatus) kProjector_LoadColGains(kProjector projector, kArray1 gains);
580 
581 
590 kFsFx(kStatus) kProjector_Stats(kProjector projector, kProjectorStats* stats);
591 
592 #include <kFireSync/Client/kProjector.x.h>
593 
594 #endif
kStatus kProjector_ControlInfo(kProjector projector, kInfoBits *info)
Reports constraint and validity information for the Control setting.
kStatus kProjector_AutoShutdownInfo(kProjector projector, kInfoBool *info)
Reports constraint and validity information for the AutoShutdown 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 display.
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 current input 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 display.
kStatus kProjector_LoadRowGains(kProjector projector, kArray1 gains)
Loads the per row gains to input pattern.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
kStatus kProjector_Enable(kProjector projector, kBool enable)
Enables or disables the projector.
kStatus kProjector_SetPatternMode(kProjector projector, kProjectorPatternMode mode)
Sets the expected format for input pattern data.
Represents projector configuration.
kStatus kProjector_BitDepthInfo(kProjector projector, kInfoSize *info)
Reports constraint and validity information for the BitDepth setting.
kStatus kProjector_LightOutputInfo(kProjector projector, kInfoBool *info)
Reports constraint and validity information for the LightOutput setting.
kStatus kProjector_SetPalette(kProjector projector, kSize index, k32u pixel)
Sets the output pixel value corresponding to the specified pattern input value.
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.
kBool kProjector_AutoShutdownEnabled(kProjector projector)
Reports whether auto-shutdown is currently enabled.
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 projector 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:1211
kStatus kProjector_DeleteState(kProjector projector, kProjectorState state)
Destroys the specified state and removes it from the projector's state list.
kStatus kProjector_EnableLightOutput(kProjector projector, kBool enable)
Enables or disables light output for the projector.
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.
kStatus kProjector_LoadColGains(kProjector projector, kArray1 gains)
Loads the per column gains to input pattern.
k32u kProjector_Palette(kProjector projector, kSize index)
Gets the output pixel value corresponding to the specified pattern input value.
kBool kProjector_IsDynamicFrameRateEnabled(kProjector projector)
Reports whether 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 input pattern to be projected.
kProjectorModel kProjector_Model(kProjector projector)
Gets the model of the projector.
kStatus kProjector_EnableAutoShutdown(kProjector projector, kBool enable)
Enables or disables auto-shutdown for 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:98
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:370
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.
kBool kProjector_LightOutputEnabled(kProjector projector)
Reports whether light output is currently enabled.
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:64
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:493
kSize kProjector_BitDepth(kProjector projector)
Gets the projected pattern bit depth.