Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ForwardRenderPipeline

ForwardRenderPipeline is a one of render pipelines

remarks

A render pipeline is a class of complex multi-pass setups already built in, which allows users to easily benefit from advanced expressions such as refraction and MSAA. (like the URP (Universal Render Pipeline) in the Unity engine).

Hierarchy

Index

Constructors

Properties

__oDiffuseCubeTexture: IOption<CubeTexture> = ...
__oDrawFunc: IOption<DrawFunc> = ...
__oFrame: IOption<Frame> = ...
__oFrameBufferMsaa: IOption<FrameBuffer> = ...
__oFrameBufferResolve: IOption<FrameBuffer> = ...
__oFrameBufferResolveForReference: IOption<FrameBuffer> = ...
__oGammaBoardEntity: IOption<IMeshEntity> = ...
__oGammaCameraEntity: IOption<ICameraEntity> = ...
__oGammaExpression: IOption<Expression> = ...
__oInitialExpression: IOption<Expression> = ...
__oMsaaResolveExpression: IOption<Expression> = ...
__oSpecularCubeTexture: IOption<CubeTexture> = ...
__oWebXRSystem: IOption<any> = ...
__opaqueExpressions: Expression[] = []
__transparentExpressions: Expression[] = []
InvalidObjectUID: -1 = -1
currentMaxObjectCount: number = 0

Accessors

  • get objectUID(): number
  • get uniqueName(): string

Methods

  • __attachIBLTextureToAllMeshComponents(diffuseCubeTexture: CubeTexture, specularCubeTexture: CubeTexture, rotation: number): void
  • __createRenderTargets(canvasWidth: number, canvasHeight: number): { framebufferMsaa: FrameBuffer; framebufferResolve: FrameBuffer; framebufferResolveForReference: FrameBuffer }
  • __setExpressions(): void
  • __setExpressionsInner(expressions: Expression[], options?: { isTransmission: boolean }): void
  • __setIblInnerForOpaque(): void
  • __setIblInnerForTransparent(): void
  • __setTransparentExpressionsForTransmission(expressions: Expression[]): void
  • draw(): void
  • getMsaaResolveExpression(): undefined | Expression
  • getTag(tagName: string): Tag
  • getTagValue(tagName: string): any
  • hasTag(tagName: string): boolean
  • matchTag(tagName: string, tagValue: string): boolean
  • matchTags(tags: RnTags): boolean
  • matchTagsAsFreeStrings(stringArray: string[]): boolean
  • removeTag(tagName: string): void
  • resize(width: number, height: number): Err<unknown, undefined> | Ok<unknown, unknown>
  • setDiffuseIBLContribution(value: number): void
  • setExpressions(expressions: Expression[], options?: { isTransmission: boolean }): void
  • setIBL(arg: { diffuse: IBLCubeTextureParameter; specular: IBLCubeTextureParameter }): void
  • set IBL textures from uri

    Parameters

    • arg: { diffuse: IBLCubeTextureParameter; specular: IBLCubeTextureParameter }

      argument for diffuse and specular IBL

      • diffuse: IBLCubeTextureParameter
      • specular: IBLCubeTextureParameter

    Returns void

  • setIBLRotation(radian: number): void
  • setSpecularIBLContribution(value: number): void
  • setup(canvasWidth: number, canvasHeight: number): Promise<Err<unknown, undefined> | Ok<unknown, unknown>>
  • startRenderLoop(func: ((frame: Frame) => void)): Err<unknown, undefined> | Ok<unknown, unknown>
  • tryToSetTag(tag: Tag): boolean
  • tryToSetUniqueName(name: string, toAddNameIfConflict: boolean): boolean
  • Try to set a unique name of the entity.

    Parameters

    • name: string
    • toAddNameIfConflict: boolean

      If true, force to add name string to the current unique name string. If false, give up to change name.

    Returns boolean

  • validateTagString(val: string): boolean
  • _reset(): void
  • getRnObject(objectUid: number): RnObject
  • getRnObjectByName(uniqueName: string): undefined | RnObject
  • searchByTag(tag: string, value: string): undefined | RnObject

Generated using TypeDoc