beastapi/beastcamera.h Source File

beastcamera.h
Go to the documentation of this file.
1 /*
2 Copyright 2014 Autodesk, Inc. All rights reserved.
3 Use of this software is subject to the terms of the Autodesk license agreement
4 provided at the time of installation or download, or which otherwise
5 accompanies this software in either electronic or hard copy form.
6 */
7 
8 
12 #ifndef BEASTCAMERA_H
13 #define BEASTCAMERA_H
14 #include "beastapitypes.h"
15 #ifdef __cplusplus
16 extern "C" {
17 #endif // __cplusplus
18 
22  typedef enum {
27 
32 
38 
50  ILB_DLL_FUNCTION ILBStatus ILBCreatePerspectiveCamera(ILBSceneHandle scene,
51  ILBConstString name,
52  const ILBMatrix4x4* transform,
53  ILBCameraHandle* camera);
54 
64  ILB_DLL_FUNCTION ILBStatus ILBCreateEnvironmentCamera(ILBSceneHandle scene,
65  ILBConstString name,
66  const ILBMatrix4x4* transform,
68  ILBCameraHandle* camera);
69 
76  ILB_DLL_FUNCTION ILBStatus ILBSetCameraTransform(ILBCameraHandle camera,
77  const ILBMatrix4x4* transform);
78 
87  const ILBMatrix4x4* transforms,
88  int32 count);
89 
102  ILB_DLL_FUNCTION ILBStatus ILBSetFov(ILBCameraHandle camera,
103  float horizontalFovRadians,
104  float pixelAspectRatio);
105 
116  ILB_DLL_FUNCTION ILBStatus ILBSetVerticalFov(ILBCameraHandle camera,
117  float verticalFovRadians);
118 
127  ILB_DLL_FUNCTION ILBStatus ILBSetCameraDisplayName(ILBCameraHandle camera,
128  ILBConstString displayName);
129 
138  ILB_DLL_FUNCTION ILBStatus ILBSetCameraDof(ILBCameraHandle camera,
139  float fstop,
140  float focusDistance,
141  int32 blades);
142 
150  ILB_DLL_FUNCTION ILBStatus ILBGetCameraTransform(ILBCameraHandle camera,
151  ILBMatrix4x4* transform);
152 
159  ILB_DLL_FUNCTION ILBStatus ILBGetCameraName(ILBCameraHandle camera,
160  ILBStringHandle* name);
161 
173  ILB_DLL_FUNCTION ILBStatus ILBGetCameraFov(ILBCameraHandle camera,
174  float* horizontalFovRadians,
175  float* pixelAspectRatio);
176 
177 
178 #ifdef __cplusplus
179 }
180 #endif // __cplusplus
181 
182 
183 #endif // BEASTCAMERA_H
184 
185 
ILBStatus ILBGetCameraFov(ILBCameraHandle camera, float *horizontalFovRadians, float *pixelAspectRatio)
Gets the fov of the camera.
This header is the base for getting platform consistent types for the Beast API.
const ILBCharType * ILBConstString
Beast api const string type.
Definition: beastapitypes.h:245
Handle for Beast cameras Intentionally hidden implementation.
Definition: beastapitypes.h:429
Latlong environment camera.
Definition: beastcamera.h:36
Cubemap environment camera.
Definition: beastcamera.h:26
ILBEnvironmentCameraType
Environment camera types.
Definition: beastcamera.h:22
ILBStatus ILBGetCameraTransform(ILBCameraHandle camera, ILBMatrix4x4 *transform)
Gets the transform of a camera.
Matrix for transformations.
Definition: beastapitypes.h:383
ILBStatus ILBSetCameraDof(ILBCameraHandle camera, float fstop, float focusDistance, int32 blades)
Sets depth of field parameters for the camera.
Ball environment camera.
Definition: beastcamera.h:31
ILBStatus ILBCreatePerspectiveCamera(ILBSceneHandle scene, ILBConstString name, const ILBMatrix4x4 *transform, ILBCameraHandle *camera)
Add a camera to the scene.
ILBStatus ILBCreateEnvironmentCamera(ILBSceneHandle scene, ILBConstString name, const ILBMatrix4x4 *transform, ILBEnvironmentCameraType type, ILBCameraHandle *camera)
Add an environment camera to the scene.
ILBStatus ILBSetCameraMotionTransforms(ILBCameraHandle camera, const ILBMatrix4x4 *transforms, int32 count)
Sets the motion transforms of a motion blurred camera.
ILBStatus ILBGetCameraName(ILBCameraHandle camera, ILBStringHandle *name)
Gets the name of a camera.
ILBStatus ILBSetCameraDisplayName(ILBCameraHandle camera, ILBConstString displayName)
Sets the display name for the camera.
ILBStatus ILBSetCameraTransform(ILBCameraHandle camera, const ILBMatrix4x4 *transform)
Sets the transform of a camera.
Handle for Beast scenes Intentionally hidden implementation.
Definition: beastapitypes.h:408
ILBStatus ILBSetVerticalFov(ILBCameraHandle camera, float verticalFovRadians)
Sets the vertical fov of the camera.
ILBStatus
Status codes for Beast API calls.
Definition: beastapitypes.h:153
ILBStatus ILBSetFov(ILBCameraHandle camera, float horizontalFovRadians, float pixelAspectRatio)
Sets the fov of the camera.
Handle for Beast strings Intentionally hidden implementation.
Definition: beastapitypes.h:471