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

Description

Represents constraint and validity information for a kSize setting.

Inheritance diagram for kInfoSize:
Inheritance graph

Public Member Functions

kSize kInfoSize_Adjust (kInfoSize *info, kSize value, kAdjust style)
 Adjusts the specified value based on min/max/granularity constaints. More...
 
kStatus kInfoSize_Init (kInfoSize *info, kSize min, kSize max, kSize granularity)
 Initializes a kInfoSize structure to default values. More...
 
kStatus kInfoSize_Validate (kInfoSize *info, kSize value)
 Validates an input value against min/max/granularity values. More...
 

Public Attributes

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