Class CameraComponentElement

The CameraComponentElement interface provides properties and methods for manipulating <pc-camera> elements. The CameraComponentElement interface also inherits the properties and methods of the HTMLElement interface.

Hierarchy (View Summary)

ComponentElement
- CameraComponentElement

Accessors

clearColor

get clearColor(): Color
Gets the clear color of the camera.

Returns Color
The clear color.
- Defined in src/components/camera-component.ts:141
set clearColor(value: Color): void
Sets the clear color of the camera.
Parameters
- value: Color
  The clear color.
Returns void
- Defined in src/components/camera-component.ts:130

clearColorBuffer

get clearColorBuffer(): boolean
Gets the clear color buffer of the camera.

Returns boolean
The clear color buffer.
- Defined in src/components/camera-component.ts:160
set clearColorBuffer(value: boolean): void
Sets the clear color buffer of the camera.
Parameters
- value: boolean
  The clear color buffer.
Returns void
- Defined in src/components/camera-component.ts:149

clearDepthBuffer

get clearDepthBuffer(): boolean
Gets the clear depth buffer of the camera.

Returns boolean
The clear depth buffer.
- Defined in src/components/camera-component.ts:179
set clearDepthBuffer(value: boolean): void
Sets the clear depth buffer of the camera.
Parameters
- value: boolean
  The clear depth buffer.
Returns void
- Defined in src/components/camera-component.ts:168

clearStencilBuffer

get clearStencilBuffer(): boolean
Gets the clear stencil buffer of the camera.

Returns boolean
The clear stencil buffer.
- Defined in src/components/camera-component.ts:198
set clearStencilBuffer(value: boolean): void
Sets the clear stencil buffer of the camera.
Parameters
- value: boolean
  The clear stencil buffer.
Returns void
- Defined in src/components/camera-component.ts:187

closestApp

get closestApp(): AppElement | null
The nearest ancestor <pc-app> element, or null if this element has no <pc-app> ancestor. The search starts at the parent, so an element never resolves to itself.

Returns AppElement | null
The closest app element, or null.
Inherited from ComponentElement.closestApp
- Defined in src/async-element.ts:28

closestEntity

get closestEntity(): EntityElement | null
The nearest ancestor <pc-entity> element, or null if this element has no <pc-entity> ancestor. The search starts at the parent, so an element never resolves to itself.

Returns EntityElement | null
The closest entity element, or null.
Inherited from ComponentElement.closestEntity
- Defined in src/async-element.ts:37

component

get component(): CameraComponent
Gets the underlying PlayCanvas camera component.

Returns CameraComponent
The camera component.
Overrides ComponentElement.component
- Defined in src/components/camera-component.ts:122

cullFaces

get cullFaces(): boolean
Gets the cull faces of the camera.

Returns boolean
The cull faces.
- Defined in src/components/camera-component.ts:217
set cullFaces(value: boolean): void
Sets the cull faces of the camera.
Parameters
- value: boolean
  The cull faces.
Returns void
- Defined in src/components/camera-component.ts:206

enabled

get enabled(): boolean
Gets the enabled state of the component.

Returns boolean
The enabled state of the component.
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:100
set enabled(value: boolean): void
Sets the enabled state of the component.
Parameters
- value: boolean
  The enabled state of the component.
Returns void
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:89

farClip

get farClip(): number
Gets the far clip distance of the camera.

Returns number
The far clip distance.
- Defined in src/components/camera-component.ts:236
set farClip(value: number): void
Sets the far clip distance of the camera.
Parameters
- value: number
  The far clip distance.
Returns void
- Defined in src/components/camera-component.ts:225

flipFaces

get flipFaces(): boolean
Gets the flip faces of the camera.

Returns boolean
The flip faces.
- Defined in src/components/camera-component.ts:255
set flipFaces(value: boolean): void
Sets the flip faces of the camera.
Parameters
- value: boolean
  The flip faces.
Returns void
- Defined in src/components/camera-component.ts:244

fov

get fov(): number
Gets the field of view of the camera.

Returns number
The field of view.
- Defined in src/components/camera-component.ts:274
set fov(value: number): void
Sets the field of view of the camera.
Parameters
- value: number
  The field of view.
Returns void
- Defined in src/components/camera-component.ts:263

frustumCulling

get frustumCulling(): boolean
Gets the frustum culling of the camera.

Returns boolean
The frustum culling.
- Defined in src/components/camera-component.ts:293
set frustumCulling(value: boolean): void
Sets the frustum culling of the camera.
Parameters
- value: boolean
  The frustum culling.
Returns void
- Defined in src/components/camera-component.ts:282

gamma

get gamma(): "linear" | "srgb"
Gets the gamma correction of the camera.

Returns "linear" | "srgb"
The gamma correction.
- Defined in src/components/camera-component.ts:312
set gamma(value: "linear" | "srgb"): void
Sets the gamma correction of the camera.
Parameters
- value: "linear" | "srgb"
  The gamma correction.
Returns void
- Defined in src/components/camera-component.ts:301

horizontalFov

get horizontalFov(): boolean
Gets whether the camera's field of view (fov) is horizontal or vertical.

Returns boolean
Whether the camera's field of view is horizontal.
- Defined in src/components/camera-component.ts:332
set horizontalFov(value: boolean): void
Sets whether the camera's field of view (fov) is horizontal or vertical. Defaults to false (meaning it is vertical be default).
Parameters
- value: boolean
  Whether the camera's field of view is horizontal.
Returns void
- Defined in src/components/camera-component.ts:321

nearClip

get nearClip(): number
Gets the near clip distance of the camera.

Returns number
The near clip distance.
- Defined in src/components/camera-component.ts:351
set nearClip(value: number): void
Sets the near clip distance of the camera.
Parameters
- value: number
  The near clip distance.
Returns void
- Defined in src/components/camera-component.ts:340

orthographic

get orthographic(): boolean
Gets the orthographic projection of the camera.

Returns boolean
The orthographic projection.
- Defined in src/components/camera-component.ts:370
set orthographic(value: boolean): void
Sets the orthographic projection of the camera.
Parameters
- value: boolean
  The orthographic projection.
Returns void
- Defined in src/components/camera-component.ts:359

orthoHeight

get orthoHeight(): number
Gets the orthographic height of the camera.

Returns number
The orthographic height.
- Defined in src/components/camera-component.ts:389
set orthoHeight(value: number): void
Sets the orthographic height of the camera.
Parameters
- value: number
  The orthographic height.
Returns void
- Defined in src/components/camera-component.ts:378

priority

get priority(): number
Gets the priority of the camera.

Returns number
The priority.
- Defined in src/components/camera-component.ts:408
set priority(value: number): void
Sets the priority of the camera.
Parameters
- value: number
  The priority.
Returns void
- Defined in src/components/camera-component.ts:397

rect

get rect(): Vec4
Gets the rect of the camera.

Returns Vec4
The rect.
- Defined in src/components/camera-component.ts:427
set rect(value: Vec4): void
Sets the rect of the camera.
Parameters
- value: Vec4
  The rect.
Returns void
- Defined in src/components/camera-component.ts:416

scissorRect

get scissorRect(): Vec4
Gets the scissor rect of the camera.

Returns Vec4
The scissor rect.
- Defined in src/components/camera-component.ts:446
set scissorRect(value: Vec4): void
Sets the scissor rect of the camera.
Parameters
- value: Vec4
  The scissor rect.
Returns void
- Defined in src/components/camera-component.ts:435

tonemap

get tonemap(): | "linear"
| "none"
| "filmic"
| "hejl"
| "aces"
| "aces2"
| "neutral"
Gets the tone mapping of the camera.

Returns "linear" | "none" | "filmic" | "hejl" | "aces" | "aces2" | "neutral"
The tone mapping.
- Defined in src/components/camera-component.ts:465
set tonemap(
    value:
        | "linear"
        | "none"
        | "filmic"
        | "hejl"
        | "aces"
        | "aces2"
        | "neutral",
): void
Sets the tone mapping of the camera.
Parameters
- value: "linear" | "none" | "filmic" | "hejl" | "aces" | "aces2" | "neutral"
  The tone mapping.
Returns void
- Defined in src/components/camera-component.ts:454

Methods

`Protected`_onReady

_onReady(): void
Called when the element is fully initialized and ready. Subclasses should call this when they're ready. Resolves the ready promise and dispatches a bubbling, composed ready event.

Returns void
Inherited from ComponentElement._onReady
- Defined in src/async-element.ts:46

endXr

endXr(): void
Ends the camera's XR mode.

Returns void
- Defined in src/components/camera-component.ts:112

ready

ready(): Promise<CameraComponentElement>
Returns a promise that resolves with this element when it's ready. This is the low-level primitive underlying whenReady, which is the recommended way to wait for elements.

Returns Promise<CameraComponentElement>
A promise that resolves with this element when it's ready.
Inherited from ComponentElement.ready
- Defined in src/async-element.ts:56

startXr

startXr(
type: "immersive-vr" | "immersive-ar",
space: "bounded-floor" | "local" | "local-floor" | "unbounded" | "viewer",
): void
Starts the camera in XR mode.
Parameters
- type: "immersive-vr" | "immersive-ar"
  The type of XR mode to start.
- space: "bounded-floor" | "local" | "local-floor" | "unbounded" | "viewer"
  The space to start the camera in.
Returns void
- Defined in src/components/camera-component.ts:99

Class CameraComponentElement

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

clearColor

Returns Color

Parameters

Returns void

clearColorBuffer

Returns boolean

Parameters

Returns void

clearDepthBuffer

Returns boolean

Parameters

Returns void

clearStencilBuffer

Returns boolean

Parameters

Returns void

closestApp

Returns AppElement | null

closestEntity

Returns EntityElement | null

component

Returns CameraComponent

cullFaces

Returns boolean

Parameters

Returns void

enabled

Returns boolean

Parameters

Returns void

farClip

Returns number

Parameters

Returns void

flipFaces

Returns boolean

Parameters

Returns void

fov

Returns number

Parameters

Returns void

frustumCulling

Returns boolean

Parameters

Returns void

gamma

Returns "linear" | "srgb"

Parameters

Returns void

horizontalFov

Returns boolean

Parameters

Returns void

nearClip

Returns number

Parameters

Returns void

orthographic

Returns boolean

Parameters

Returns void

orthoHeight

Returns number

Parameters

Returns void

priority

Returns number

Parameters

Returns void

rect

Returns Vec4

Parameters

Returns void

`Protected`_onReady