RoyInterface / Exports / scene/RoyCamera3D / RoyCamera3D

Class: RoyCamera3D

scene/RoyCamera3D.RoyCamera3D

Table of contents

Constructors

• constructor

Properties

• cacheViewInvQuat
• cacheVe4
• cachePlaneNv
• cacheV0
• cacheV1
• cacheWFrustumVtxArr
• sTypeClass
• m_cameraComp
• m_parentScene
• m_impl
• m_rendererTypeDirty
• m_rendererType
• m_isPrensetCamera
• m_viewExecStrategy
• m_tintCorrection
• m_renderCallback
• m_bloomOption
• m_ssReflectionsOption
• m_ssRefractionEnabled
• m_renderScale
• m_noBufferPadding
• m_isGrabDepthBlur
• m_ambientOcclusionOptions
• m_dynamicResolutionOptions
• m_depthOfFieldOptions
• m_multiSampleAntiAliasingOptions
• m_temporalAntiAliasingOptions
• m_fogOptions
• m_vignetteOptions
• m_vsmShadowOptions
• m_softShadowOptions
• m_clippingPlanesOptions
• m_guardBandOptions
• m_colorGradingOptions
• m_selectFocusOptions
• m_rayTraceOptions
• m_rayTraceNoiseData
• m_shadowType
• viewMatDirtyFrameId
• m_projMat
• m_projectType
• m_viewMat
• m_viewMatRaw
• m_viewInvertMat
• m_eye
• m_dir
• m_nearPlaneWidth
• m_nearPlaneHeight
• m_fovy
• m_aspect
• m_zNear
• m_zFar
• m_width
• m_height
• m_left
• m_right
• m_top
• m_bottom
• m_orthoViewScale
• m_frustumArray
• m_wFrustumPlaneArr
• m_frustumWAABB
• m_projOrViewchanged
• m_setAlphaToOne
• m_blendMode
• m_viewRect
• m_displayScreenRadio
• m_clearColor
• m_draftClearColor
• m_clearBackBufferOptions
• m_physicalCameraOptions
• m_effectMode
• m_renderLevel
• m_effectIgnoreDRO
• m_visibleLayer
• m_frontFaceWindingInverted
• m_frontFaceWindingAutoInverted
• m_snapImageOptions
• m_snapRTObjectOptions
• m_renderTarget

Accessors

• parentScene
• impl
• rendererTypeDirty
• rendererType
• present
• viewExecStrategy
• tintCorrection
• renderCallback
• bloomOption
• ssReflectionsOption
• ssRefractionEnabled
• renderScale
• noBufferPadding
• isGrabDepthBlur
• ambientOcclusionOptions
• dynamicResolutionOptions
• depthOfFieldOptions
• multiSampleAntiAliasingOptions
• temporalAntiAliasingOptions
• fogOptions
• vignetteOptions
• vsmShadowOptions
• softShadowOptions
• clippingPlanesOptions
• guardBandOptions
• colorGradingOptions
• selectFocusOptions
• rayTraceOptions
• rayTraceNoiseData
• shadowType
• projMat
• projectType
• viewMat
• viewMatRaw
• viewInvertMat
• eye
• dir
• nearPlaneWidth
• nearPlaneHeight
• fovy
• aspect
• zNear
• zFar
• width
• height
• left
• right
• top
• bottom
• orthoViewScale
• frustumArray
• setAlphaToOne
• blendMode
• viewRect
• displayScreenRadio
• clearColor
• draftClearColor
• clearBackBufferOptions
• physicalCameraOptions
• effectMode
• renderLevel
• effectIgnoreDRO
• visibleLayer
• frontFaceWindingInverted
• frontFaceWindingAutoInverted
• snapImageOptions
• snapRTObjectOptions
• renderTarget

Methods

• registerImplClass
• createDefaultBloomOptions
• createDefaultScreenSpaceReflectionsOptions
• createDefaultAmbientOcclusionOptions
• createDefaultDynamicResolutionOptions
• createDefaultDepthOfFieldOptions
• createDefaultMultiSampleAntiAliasingOptions
• createDefaultTemporalAntiAliasingOptions
• createDefaultFogOptions
• createDefaultVignetteOptions
• createDefaultVsmShadowOptions
• createDefaultSoftShadowOptions
• createDefaultClippingPlanesOptions
• createDefaultGuardBandOptions
• createDefaultColorGradingOptions
• createDefaultSelectFocusOptions
• createDefaultRayTraceOptions
• createDefaultRayTraceSVGFDenoiseOptions
• createDefaultRayTraceDofOptions
• getWorldFrustumPlanes
• getWordFrustumWAABB
• createDefaultClearOptions
• createDefaultPhysicalCameraOptions
• ev100
• exposure
• isBestEffect
• setParamDirty
• setClearTargets
• perspectiveRH2
• orthoRH
• updateViewMat
• screenPointToWorld
• worldPointToScreen
• getWorldPickingRayByScreenXY
• getFrustumPoint
• getFrustumPlanes
• destroy
• onAddToScene
• onRemoveFromScene
• syncToEngine
• preRender
• render
• postRender

Constructors

constructor

• new RoyCamera3D(cameraComp, scene): RoyCamera3D

Parameters

Name	Type
cameraComp	RoyCameraComponent
scene	RoyScene

Returns

RoyCamera3D

Properties

cacheViewInvQuat

▪ Static Protected cacheViewInvQuat: Quat

---

cacheVe4

▪ Static Protected cacheVe4: Vec4

---

cachePlaneNv

▪ Static Protected cachePlaneNv: Vec3

---

cacheV0

▪ Static Protected cacheV0: Vec3

---

cacheV1

▪ Static Protected cacheV1: Vec3

---

cacheWFrustumVtxArr

▪ Static Protected cacheWFrustumVtxArr: Vec3[]

---

sTypeClass

▪ Static Protected sTypeClass: Object = {}

Index signature

▪ [key: number]: RoyCameraImplClass

---

m_cameraComp

• Private m_cameraComp: RoyCameraComponent

---

m_parentScene

• Private m_parentScene: RoyScene

---

m_impl

• Private m_impl: RoyCameraImpl[]

---

m_rendererTypeDirty

• Private m_rendererTypeDirty: boolean = true

---

m_rendererType

• Private m_rendererType: RendererType

---

m_isPrensetCamera

• Private m_isPrensetCamera: boolean = true

---

m_viewExecStrategy

• Protected m_viewExecStrategy: ViewExecutionStrategy = ViewExecutionStrategy.Default

---

m_tintCorrection

• Protected m_tintCorrection: boolean = false

---

m_renderCallback

• Private m_renderCallback: RenderCallbackInfo

---

m_bloomOption

• Private m_bloomOption: View$BloomOptions

---

m_ssReflectionsOption

• Private m_ssReflectionsOption: View$ScreenSpaceReflectionsOptions

---

m_ssRefractionEnabled

• Private m_ssRefractionEnabled: boolean = false

---

m_renderScale

• Private m_renderScale: number = 1.0

---

m_noBufferPadding

• Private m_noBufferPadding: boolean = false

---

m_isGrabDepthBlur

• Private m_isGrabDepthBlur: boolean = false

---

m_ambientOcclusionOptions

• Private m_ambientOcclusionOptions: View$AmbientOcclusionOptions

---

m_dynamicResolutionOptions

• Private m_dynamicResolutionOptions: View$DynamicResolutionOptions

---

m_depthOfFieldOptions

• Private m_depthOfFieldOptions: View$DepthOfFieldOptions

---

m_multiSampleAntiAliasingOptions

• Private m_multiSampleAntiAliasingOptions: View$MultiSampleAntiAliasingOptions

---

m_temporalAntiAliasingOptions

• Private m_temporalAntiAliasingOptions: View$TemporalAntiAliasingOptions

---

m_fogOptions

• Private m_fogOptions: View$FogOptions

---

m_vignetteOptions

• Private m_vignetteOptions: View$VignetteOptions

---

m_vsmShadowOptions

• Private m_vsmShadowOptions: View$VsmShadowOptions

---

m_softShadowOptions

• Private m_softShadowOptions: View$SoftShadowOptions

---

m_clippingPlanesOptions

• Private m_clippingPlanesOptions: View$ClippingPlanesOptions

---

m_guardBandOptions

• Private m_guardBandOptions: View$GuardBandOptions

---

m_colorGradingOptions

• Private m_colorGradingOptions: ColorGradingOptions

---

m_selectFocusOptions

• Private m_selectFocusOptions: SelectFocusOptions

---

m_rayTraceOptions

• Private m_rayTraceOptions: RayTraceOptions

---

m_rayTraceNoiseData

• Private m_rayTraceNoiseData: Uint8Array = null

---

m_shadowType

• Private m_shadowType: View$ShadowType = View$ShadowType.PCF

---

viewMatDirtyFrameId

• viewMatDirtyFrameId: number = 0

---

m_projMat

• Private m_projMat: Mat4

---

m_projectType

• Private m_projectType: RoyCameraProjType = RoyCameraProjType.Ortho

---

m_viewMat

• Private m_viewMat: Mat4

---

m_viewMatRaw

• Private m_viewMatRaw: Mat4

---

m_viewInvertMat

• Private m_viewInvertMat: Mat4

---

m_eye

• Private m_eye: Vec3

---

m_dir

• Private m_dir: Vec3

---

m_nearPlaneWidth

• Private m_nearPlaneWidth: number = 1.0

---

m_nearPlaneHeight

• Private m_nearPlaneHeight: number = 1.0

---

m_fovy

• Private m_fovy: number = 0.0

---

m_aspect

• Private m_aspect: number = 1.0

---

m_zNear

• Private m_zNear: number = 0.1

---

m_zFar

• Private m_zFar: number = 1000.0

---

m_width

• Private m_width: number = 0

---

m_height

• Private m_height: number = 0

---

m_left

• Private m_left: number = -300.0

---

m_right

• Private m_right: number = 300.0

---

m_top

• Private m_top: number = 400.0

---

m_bottom

• Private m_bottom: number = -400.0

---

m_orthoViewScale

• Private m_orthoViewScale: number = 1.0

---

m_frustumArray

• Private m_frustumArray: Float32Array

---

m_wFrustumPlaneArr

• Private m_wFrustumPlaneArr: Plane[]

---

m_frustumWAABB

• Private m_frustumWAABB: AABB

---

m_projOrViewchanged

• Private m_projOrViewchanged: boolean = true

---

m_setAlphaToOne

• Private m_setAlphaToOne: boolean = false

---

m_blendMode

• Private m_blendMode: View$BlendMode = View$BlendMode.OPAQUE

---

m_viewRect

• Private m_viewRect: number[]

---

m_displayScreenRadio

• Private m_displayScreenRadio: number = 1.0

---

m_clearColor

• Private m_clearColor: number[]

---

m_draftClearColor

• Private m_draftClearColor: number[]

---

m_clearBackBufferOptions

• Private m_clearBackBufferOptions: Renderer$ClearOptions

---

m_physicalCameraOptions

• Private m_physicalCameraOptions: PhysicalCameraOptions

---

m_effectMode

• Private m_effectMode: CameraEffectMode = CameraEffectMode.Color

---

m_renderLevel

• Private m_renderLevel: RendererLevel = RendererLevel.HighQuality

---

m_effectIgnoreDRO

• Private m_effectIgnoreDRO: boolean = false

---

m_visibleLayer

• Private m_visibleLayer: number = 0xff

---

m_frontFaceWindingInverted

• Private m_frontFaceWindingInverted: boolean = false

---

m_frontFaceWindingAutoInverted

• Private m_frontFaceWindingAutoInverted: boolean = false

---

m_snapImageOptions

• Private m_snapImageOptions: SnapImageOptions

---

m_snapRTObjectOptions

• Private m_snapRTObjectOptions: SnapRTOptions

---

m_renderTarget

• Private m_renderTarget: RoyRenderTarget

Accessors

parentScene

• get parentScene(): RoyScene

Returns

RoyScene

---

impl

• get impl(): RoyCameraImpl[]

Returns

RoyCameraImpl[]

---

rendererTypeDirty

• get rendererTypeDirty(): boolean

Returns

boolean

---

rendererType

• get rendererType(): RendererType

Returns

RendererType

• set rendererType(value): void

Parameters

Name	Type
value	RendererType

Returns

void

---

present

• get present(): boolean

Returns

boolean

• set present(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

viewExecStrategy

• get viewExecStrategy(): ViewExecutionStrategy

Returns

ViewExecutionStrategy

• set viewExecStrategy(value): void

Parameters

Name	Type
value	ViewExecutionStrategy

Returns

void

---

tintCorrection

• get tintCorrection(): boolean

Returns

boolean

• set tintCorrection(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

renderCallback

• get renderCallback(): RenderCallbackInfo

Returns

RenderCallbackInfo

• set renderCallback(value): void

Parameters

Name	Type
value	RenderCallbackInfo

Returns

void

---

bloomOption

• get bloomOption(): View$BloomOptions

Returns

View$BloomOptions

• set bloomOption(value): void

Parameters

Name	Type
value	View$BloomOptions

Returns

void

---

ssReflectionsOption

• get ssReflectionsOption(): View$ScreenSpaceReflectionsOptions

Returns

View$ScreenSpaceReflectionsOptions

• set ssReflectionsOption(value): void

Parameters

Name	Type
value	View$ScreenSpaceReflectionsOptions

Returns

void

---

ssRefractionEnabled

• get ssRefractionEnabled(): boolean

Returns

boolean

• set ssRefractionEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

renderScale

• get renderScale(): number

Returns

number

• set renderScale(value): void

Parameters

Name	Type
value	number

Returns

void

---

noBufferPadding

• get noBufferPadding(): boolean

Returns

boolean

• set noBufferPadding(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

isGrabDepthBlur

• get isGrabDepthBlur(): boolean

Returns

boolean

• set isGrabDepthBlur(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

ambientOcclusionOptions

• get ambientOcclusionOptions(): View$AmbientOcclusionOptions

Returns

View$AmbientOcclusionOptions

• set ambientOcclusionOptions(value): void

Parameters

Name	Type
value	View$AmbientOcclusionOptions

Returns

void

---

dynamicResolutionOptions

• get dynamicResolutionOptions(): View$DynamicResolutionOptions

Returns

View$DynamicResolutionOptions

• set dynamicResolutionOptions(value): void

Parameters

Name	Type
value	View$DynamicResolutionOptions

Returns

void

---

depthOfFieldOptions

• get depthOfFieldOptions(): View$DepthOfFieldOptions

Returns

View$DepthOfFieldOptions

• set depthOfFieldOptions(value): void

Parameters

Name	Type
value	View$DepthOfFieldOptions

Returns

void

---

multiSampleAntiAliasingOptions

• get multiSampleAntiAliasingOptions(): View$MultiSampleAntiAliasingOptions

Returns

View$MultiSampleAntiAliasingOptions

• set multiSampleAntiAliasingOptions(value): void

Parameters

Name	Type
value	View$MultiSampleAntiAliasingOptions

Returns

void

---

temporalAntiAliasingOptions

• get temporalAntiAliasingOptions(): View$TemporalAntiAliasingOptions

Returns

View$TemporalAntiAliasingOptions

• set temporalAntiAliasingOptions(value): void

Parameters

Name	Type
value	View$TemporalAntiAliasingOptions

Returns

void

---

fogOptions

• get fogOptions(): View$FogOptions

Returns

View$FogOptions

• set fogOptions(value): void

Parameters

Name	Type
value	View$FogOptions

Returns

void

---

vignetteOptions

• get vignetteOptions(): View$VignetteOptions

Returns

View$VignetteOptions

• set vignetteOptions(value): void

Parameters

Name	Type
value	View$VignetteOptions

Returns

void

---

vsmShadowOptions

• get vsmShadowOptions(): View$VsmShadowOptions

Returns

View$VsmShadowOptions

• set vsmShadowOptions(value): void

Parameters

Name	Type
value	View$VsmShadowOptions

Returns

void

---

softShadowOptions

• get softShadowOptions(): View$SoftShadowOptions

Returns

View$SoftShadowOptions

• set softShadowOptions(value): void

Parameters

Name	Type
value	View$SoftShadowOptions

Returns

void

---

clippingPlanesOptions

• get clippingPlanesOptions(): View$ClippingPlanesOptions

Returns

View$ClippingPlanesOptions

• set clippingPlanesOptions(value): void

Parameters

Name	Type
value	View$ClippingPlanesOptions

Returns

void

---

guardBandOptions

• get guardBandOptions(): View$GuardBandOptions

Returns

View$GuardBandOptions

• set guardBandOptions(value): void

Parameters

Name	Type
value	View$GuardBandOptions

Returns

void

---

colorGradingOptions

• get colorGradingOptions(): ColorGradingOptions

Returns

ColorGradingOptions

• set colorGradingOptions(value): void

Parameters

Name	Type
value	ColorGradingOptions

Returns

void

---

selectFocusOptions

• get selectFocusOptions(): SelectFocusOptions

Returns

SelectFocusOptions

• set selectFocusOptions(value): void

Parameters

Name	Type
value	SelectFocusOptions

Returns

void

---

rayTraceOptions

• get rayTraceOptions(): RayTraceOptions

Returns

RayTraceOptions

• set rayTraceOptions(value): void

Parameters

Name	Type
value	RayTraceOptions

Returns

void

---

rayTraceNoiseData

• get rayTraceNoiseData(): Uint8Array

Returns

Uint8Array

• set rayTraceNoiseData(data): void

Parameters

Name	Type
data	Uint8Array

Returns

void

---

shadowType

• get shadowType(): number

Returns

number

• set shadowType(value): void

Parameters

Name	Type
value	number

Returns

void

---

projMat

• get projMat(): Mat4

Returns

Mat4

---

projectType

• get projectType(): RoyCameraProjType

Returns

RoyCameraProjType

---

viewMat

• get viewMat(): Mat4

Returns

Mat4

---

viewMatRaw

• get viewMatRaw(): Mat4

Returns

Mat4

---

viewInvertMat

• get viewInvertMat(): Mat4

Returns

Mat4

---

eye

• get eye(): Vec3

Returns

Vec3

---

dir

• get dir(): Vec3

Returns

Vec3

---

nearPlaneWidth

• get nearPlaneWidth(): number

Returns

number

---

nearPlaneHeight

• get nearPlaneHeight(): number

Returns

number

---

fovy

• get fovy(): number

Returns

number

---

aspect

• get aspect(): number

Returns

number

---

zNear

• get zNear(): number

Returns

number

---

zFar

• get zFar(): number

Returns

number

---

width

• get width(): number

Returns

number

---

height

• get height(): number

Returns

number

---

left

• get left(): number

Returns

number

---

right

• get right(): number

Returns

number

---

top

• get top(): number

Returns

number

---

bottom

• get bottom(): number

Returns

number

---

orthoViewScale

• get orthoViewScale(): number

Returns

number

• set orthoViewScale(value): void

Parameters

Name	Type
value	number

Returns

void

---

frustumArray

• get frustumArray(): Float32Array

Returns

Float32Array

---

setAlphaToOne

• get setAlphaToOne(): boolean

Returns

boolean

• set setAlphaToOne(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

blendMode

• get blendMode(): View$BlendMode

Returns

View$BlendMode

• set blendMode(value): void

Parameters

Name	Type
value	View$BlendMode

Returns

void

---

viewRect

• get viewRect(): number[]

Returns

number[]

• set viewRect(value): void

Parameters

Name	Type
value	number[]

Returns

void

---

displayScreenRadio

• get displayScreenRadio(): number

Returns

number

• set displayScreenRadio(value): void

Parameters

Name	Type
value	number

Returns

void

---

clearColor

• get clearColor(): number[]

Returns

number[]

• set clearColor(value): void

Parameters

Name	Type
value	number[]

Returns

void

---

draftClearColor

• get draftClearColor(): number[]

Returns

number[]

• set draftClearColor(value): void

Parameters

Name	Type
value	number[]

Returns

void

---

clearBackBufferOptions

• get clearBackBufferOptions(): Renderer$ClearOptions

Returns

Renderer$ClearOptions

• set clearBackBufferOptions(value): void

Parameters

Name	Type
value	Renderer$ClearOptions

Returns

void

---

physicalCameraOptions

• get physicalCameraOptions(): PhysicalCameraOptions

Returns

PhysicalCameraOptions

• set physicalCameraOptions(value): void

Parameters

Name	Type
value	PhysicalCameraOptions

Returns

void

---

effectMode

• get effectMode(): CameraEffectMode

Returns

CameraEffectMode

• set effectMode(value): void

Parameters

Name	Type
value	CameraEffectMode

Returns

void

---

renderLevel

• get renderLevel(): RendererLevel

Returns

RendererLevel

• set renderLevel(value): void

Parameters

Name	Type
value	RendererLevel

Returns

void

---

effectIgnoreDRO

• get effectIgnoreDRO(): boolean

Returns

boolean

• set effectIgnoreDRO(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

visibleLayer

• get visibleLayer(): number

Returns

number

• set visibleLayer(value): void

Parameters

Name	Type
value	number

Returns

void

---

frontFaceWindingInverted

• get frontFaceWindingInverted(): boolean

Returns

boolean

• set frontFaceWindingInverted(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

frontFaceWindingAutoInverted

• get frontFaceWindingAutoInverted(): boolean

Returns

boolean

• set frontFaceWindingAutoInverted(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

snapImageOptions

• get snapImageOptions(): SnapImageOptions

Returns

SnapImageOptions

• set snapImageOptions(value): void

Parameters

Name	Type
value	SnapImageOptions

Returns

void

---

snapRTObjectOptions

• get snapRTObjectOptions(): SnapRTOptions

Returns

SnapRTOptions

• set snapRTObjectOptions(value): void

Parameters

Name	Type
value	SnapRTOptions

Returns

void

---

renderTarget

• get renderTarget(): RoyRenderTarget

Returns

RoyRenderTarget

• set renderTarget(renderTarget): void

Parameters

Name	Type
renderTarget	RoyRenderTarget

Returns

void

Methods

registerImplClass

▸ registerImplClass(type, classIns): void

Parameters

Name	Type
type	RendererType
classIns	RoyCameraImplClass

Returns

void

---

createDefaultBloomOptions

▸ createDefaultBloomOptions(): View$BloomOptions

Returns

View$BloomOptions

---

createDefaultScreenSpaceReflectionsOptions

▸ createDefaultScreenSpaceReflectionsOptions(): View$ScreenSpaceReflectionsOptions

Returns

View$ScreenSpaceReflectionsOptions

---

createDefaultAmbientOcclusionOptions

▸ createDefaultAmbientOcclusionOptions(): View$AmbientOcclusionOptions

Returns

View$AmbientOcclusionOptions

---

createDefaultDynamicResolutionOptions

▸ createDefaultDynamicResolutionOptions(): View$DynamicResolutionOptions

Returns

View$DynamicResolutionOptions

---

createDefaultDepthOfFieldOptions

▸ createDefaultDepthOfFieldOptions(): View$DepthOfFieldOptions

Returns

View$DepthOfFieldOptions

---

createDefaultMultiSampleAntiAliasingOptions

▸ createDefaultMultiSampleAntiAliasingOptions(): View$MultiSampleAntiAliasingOptions

Returns

View$MultiSampleAntiAliasingOptions

---

createDefaultTemporalAntiAliasingOptions

▸ createDefaultTemporalAntiAliasingOptions(): Object

Returns

Object

Name	Type
filterWidth	number
feedback	number
enabled	boolean

---

createDefaultFogOptions

▸ createDefaultFogOptions(): Object

Returns

Object

Name	Type
distance	number
maximumOpacity	number
height	number
heightFalloff	number
color	number[]
density	number
inScatteringStart	number
inScatteringSize	number
fogColorFromIbl	boolean
enabled	boolean

---

createDefaultVignetteOptions

▸ createDefaultVignetteOptions(): Object

Returns

Object

Name	Type
midPoint	number
roundness	number
feather	number
color	number[]
enabled	boolean

---

createDefaultVsmShadowOptions

▸ createDefaultVsmShadowOptions(): Object

Returns

Object

Name	Type
anisotropy	number
mipmapping	boolean
minVarianceScale	number
lightBleedReduction	number

---

createDefaultSoftShadowOptions

▸ createDefaultSoftShadowOptions(): Object

Returns

Object

Name	Type
penumbraScale	number
penumbraRatioScale	number

---

createDefaultClippingPlanesOptions

▸ createDefaultClippingPlanesOptions(): Object

Returns

Object

Name	Type
enabled	boolean
size	number[]
center	number[]
info	number[]

---

createDefaultGuardBandOptions

▸ createDefaultGuardBandOptions(): Object

Returns

Object

Name	Type
enabled	boolean

---

createDefaultColorGradingOptions

▸ createDefaultColorGradingOptions(): ColorGradingOptions

Returns

ColorGradingOptions

---

createDefaultSelectFocusOptions

▸ createDefaultSelectFocusOptions(): Object

Returns

Object

Name	Type
enableSelectionRender	boolean
enableFocusRender	boolean
selectionColor	number[]
focusColor	number[]
selectionLineWidth	number
focusLineWidth	number
enableSelectionFocusDepthTest	boolean

---

createDefaultRayTraceOptions

▸ createDefaultRayTraceOptions(): Object

Returns

Object

Name	Type
tileEnable	boolean
tileWidth	number
tileHeight	number
lowResRatio	number
rayBias	number
maxSpp	number
maxBounces	number
denoiseType	RTDenoiseType
svgfDenoiseOptions	{ waveletLevel: number = 5; waveletSigmaP: number = 1.0; waveletSigmaN: number = 4.0; waveletSigmaL: number = 400.0 }
svgfDenoiseOptions.waveletLevel	number
svgfDenoiseOptions.waveletSigmaP	number
svgfDenoiseOptions.waveletSigmaN	number
svgfDenoiseOptions.waveletSigmaL	number
dofOptions	{ enabled: boolean = false; focusDistance: number = 3; apertureBlades: number = 10; apertureBokehSize: number = 30; apertureRotation: number = 0; anamorphicRatio: number = 1 }
dofOptions.enabled	boolean
dofOptions.focusDistance	number
dofOptions.apertureBlades	number
dofOptions.apertureBokehSize	number
dofOptions.apertureRotation	number
dofOptions.anamorphicRatio	number
useStratifiedSample	boolean

---

createDefaultRayTraceSVGFDenoiseOptions

▸ createDefaultRayTraceSVGFDenoiseOptions(): Object

Returns

Object

Name	Type
waveletLevel	number
waveletSigmaP	number
waveletSigmaN	number
waveletSigmaL	number

---

createDefaultRayTraceDofOptions

▸ createDefaultRayTraceDofOptions(): Object

Returns

Object

Name	Type
enabled	boolean
focusDistance	number
apertureBlades	number
apertureBokehSize	number
apertureRotation	number
anamorphicRatio	number

---

getWorldFrustumPlanes

▸ getWorldFrustumPlanes(): Plane[]

Returns

Plane[]

---

getWordFrustumWAABB

▸ getWordFrustumWAABB(): AABB

Returns

AABB

---

createDefaultClearOptions

▸ createDefaultClearOptions(): Object

Returns

Object

Name	Type
clear	boolean
clearColor	number[]
discard	boolean

---

createDefaultPhysicalCameraOptions

▸ createDefaultPhysicalCameraOptions(): Object

Returns

Object

Name	Type
aperture	number
shutterSpeed	number
sensitivity	number
focusDistance	number

---

ev100

▸ ev100(): number

Returns

number

---

exposure

▸ exposure(ev100): number

Parameters

Name	Type
ev100	number

Returns

number

---

isBestEffect

▸ isBestEffect(): boolean

Returns

boolean

---

setParamDirty

▸ setParamDirty(flag): void

Parameters

Name	Type
flag	ViewDirtyFlag

Returns

void

---

setClearTargets

▸ setClearTargets(color, depth, stencil): void

Parameters

Name	Type
color	boolean
depth	boolean
stencil	boolean

Returns

void

---

perspectiveRH2

▸ perspectiveRH2(fovy, pw, ph, zNear, zFar): void

Parameters

Name	Type
fovy	number
pw	number
ph	number
zNear	number
zFar	number

Returns

void

---

orthoRH

▸ orthoRH(zNear, zFar, b, t, l, r): void

Parameters

Name	Type
zNear	number
zFar	number
b	number
t	number
l	number
r	number

Returns

void

---

updateViewMat

▸ updateViewMat(value, valueRaw?): void

Parameters

Name	Type
value	Mat4
valueRaw?	Mat4

Returns

void

---

screenPointToWorld

▸ screenPointToWorld(screenX, screenY): Vec4

Parameters

Name	Type
screenX	number
screenY	number

Returns

Vec4

---

worldPointToScreen

▸ worldPointToScreen(worldPos, flipY?): Vec2

Parameters

Name	Type
worldPos	Vec4
flipY?	boolean

Returns

Vec2

---

getWorldPickingRayByScreenXY

▸ getWorldPickingRayByScreenXY(screenX, screenY, ray_pos, ray_tv, ignoreViewOffet): void

Parameters

Name	Type
screenX	number
screenY	number
ray_pos	Vec3
ray_tv	Vec3
ignoreViewOffet	boolean

Returns

void

---

getFrustumPoint

▸ getFrustumPoint(outVertexArray, rectX, rectY, rectW, rectH): void

Parameters

Name	Type
outVertexArray	Vec3[]
rectX	number
rectY	number
rectW	number
rectH	number

Returns

void

---

getFrustumPlanes

▸ getFrustumPlanes(outPlanes, frustumVertexArray): void

Parameters

Name	Type
outPlanes	Plane[]
frustumVertexArray	Vec3[]

Returns

void

---

destroy

▸ destroy(): void

Returns

void

---

onAddToScene

▸ onAddToScene(): void

Returns

void

---

onRemoveFromScene

▸ onRemoveFromScene(): void

Returns

void

---

syncToEngine

▸ syncToEngine(): void

Returns

void

---

preRender

▸ preRender(drawWireframe): void

Parameters

Name	Type
drawWireframe	boolean

Returns

void

---

render

▸ render(forceToRender): void

Parameters

Name	Type
forceToRender	boolean

Returns

void

---

postRender

▸ postRender(): void

Returns

void