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

Description

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

Inheritance diagram for kInfo64s:
Inheritance graph

Public Member Functions

k64s kInfo64s_Adjust (kInfo64s *info, k64s value, kAdjust style)
 Adjusts the specified value based on min/max/granularity constaints. More...
 
kStatus kInfo64s_Init (kInfo64s *info, k64s min, k64s max, k64s granularity)
 Initializes a kInfo64s structure to default values. More...
 
kStatus kInfo64s_Validate (kInfo64s *info, k64s value)
 Validates an input value against min/max/granularity values. More...
 

Public Attributes

k64s absoluteMax
 Maximum valid value under any circumstances.
 
k64s absoluteMin
 Minimum valid value under any circumstances.
 
k64f accurate
 Accurate representation of current value, typically used for display in meaningful units (optional).
 
k64s 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).
 
k64s relativeMax
 Maximum valid value, limited by current values of other (more dominant) settings.
 
k64s 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: