Skip to main content

CameraInfoUtils

Utility method to transfer camera info to and from the client.

Functions​

createCameraInfo​

</>
CameraInfoUtils.createCameraInfo(
cframe: CFrame,
viewPortSize: Vector2,
fieldOfView: number
) → CameraInfo

Creates a new camera info.

fromCamera​

</>
CameraInfoUtils.fromCamera(camera: Camera) → CameraInfo

Creates a new camera info from a camera.

isCameraInfo​

</>
CameraInfoUtils.isCameraInfo(cameraInfo: any) → boolean

Returns true if the value is a cameraInfo

Show raw api
{
    "functions": [
        {
            "name": "createCameraInfo",
            "desc": "Creates a new camera info.",
            "params": [
                {
                    "name": "cframe",
                    "desc": "",
                    "lua_type": "CFrame"
                },
                {
                    "name": "viewPortSize",
                    "desc": "",
                    "lua_type": "Vector2"
                },
                {
                    "name": "fieldOfView",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraInfo"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 17,
                "path": "src/camerainfo/src/Shared/CameraInfoUtils.lua"
            }
        },
        {
            "name": "fromCamera",
            "desc": "Creates a new camera info from a camera.",
            "params": [
                {
                    "name": "camera",
                    "desc": "",
                    "lua_type": "Camera"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraInfo"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 35,
                "path": "src/camerainfo/src/Shared/CameraInfoUtils.lua"
            }
        },
        {
            "name": "isCameraInfo",
            "desc": "Returns true if the value is a cameraInfo",
            "params": [
                {
                    "name": "cameraInfo",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 46,
                "path": "src/camerainfo/src/Shared/CameraInfoUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CameraInfoUtils",
    "desc": "Utility method to transfer camera info to and from the client.",
    "source": {
        "line": 6,
        "path": "src/camerainfo/src/Shared/CameraInfoUtils.lua"
    }
}