FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kInfo32s Struct Reference

Description

Represents constraint and validity information for a 32-bit signed integer setting.

Inheritance diagram for kInfo32s:
Inheritance graph

Public Member Functions

k32s kInfo32s_Adjust (kInfo32s *info, k32s value, kAdjust style)
 Adjusts the specified value based on min/max/granularity constaints. More...
 
kStatus kInfo32s_Init (kInfo32s *info, k32s min, k32s max, k32s granularity)
 Initializes a kInfo32s structure to default values. More...
 
kStatus kInfo32s_Validate (kInfo32s *info, k32s value)
 Validates an input value against min/max/granularity values. More...
 

Public Attributes

k32s absoluteMax
 Maximum valid value under any circumstances.
 
k32s absoluteMin
 Minimum valid value under any circumstances.
 
k64f accurate
 Accurate representation of current value, typically used for display in meaningful units (optional).
 
k32s granularity
 Value must be evenly divisible by this number.
 
kBool isGrouped
 Value is constrained to be the same as its peers within a group. (e.g. periods of states belonging to a camera might be constrained to be equal).
 
kBool isReadOnly
 Value is read-only (cannot be modified).
 
k32s relativeMax
 Maximum valid value, limited by current values of other (more dominant) settings.
 
k32s relativeMin
 Minimum valid value, limited by current values of other (more dominant) settings.
 
kViolation violations
 Constraints violated by the current value.
 

The documentation for this struct was generated from the following file: