postprocessing/types/postprocessing.d.ts at main · codeTCbin25/postprocessing · GitHub

History

8379 lines (8245 loc) · 243 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

declare module "postprocessing" {

import {

Vector2,

WebGLRenderer,

Camera,

PerspectiveCamera,

Texture,

Material,

WebGLRenderTarget,

Scene,

Uniform,

Object3D,

Vector3,

ShaderMaterial,

DataTexture,

Mesh,

Points,

Loader,

DepthPackingStrategies,

DepthModes,

EventDispatcher,

Color,

TextureEncoding,

DataTexture3D,

Wrapping,

} from "three";

/**

* A color channel enumeration.

* @type {Object}

* @property {Number} RED - Red.

* @property {Number} GREEN - Green.

* @property {Number} BLUE - Blue.

* @property {Number} ALPHA - Alpha.

export enum ColorChannel {

RED,

GREEN,

BLUE,

ALPHA,

}

/**

* The Disposable contract.

* Implemented by objects that can free internal resources.

* @interface

export class Disposable {

/**

* Frees internal resources.

dispose(): void;

}

/**

* The initializable contract.

* Implemented by objects that can be initialized.

* @interface

export class Initializable {

/**

* Performs initialization tasks.

* @param {WebGLRenderer} renderer - A renderer.

* @param {Boolean} alpha - Whether the renderer uses the alpha channel.

* @param {Number} frameBufferType - The type of the main frame buffers.

initialize(

renderer: WebGLRenderer,

alpha: boolean,

frameBufferType: number

): void;

}

/**

* An adaptive luminance shader material.

export class AdaptiveLuminanceMaterial extends ShaderMaterial {

/**

* Constructs a new adaptive luminance material.

constructor();

/**

* The primary luminance buffer that contains the downsampled average luminance.

* @type {Texture}

set luminanceBuffer0(arg: Texture);

/**

* Sets the primary luminance buffer that contains the downsampled average luminance.

* @deprecated Use luminanceBuffer0 instead.

* @param {Texture} value - The buffer.

setLuminanceBuffer0(value: Texture): void;

/**

* The secondary luminance buffer.

* @type {Texture}

set luminanceBuffer1(arg: Texture);

/**

* Sets the secondary luminance buffer.

* @deprecated Use luminanceBuffer1 instead.

* @param {Texture} value - The buffer.

setLuminanceBuffer1(value: Texture): void;

/**

* The 1x1 mipmap level.

* This level is used to identify the smallest mipmap of the primary luminance buffer.

* @type {Number}

set mipLevel1x1(arg: number);

/**

* Sets the 1x1 mipmap level.

* @deprecated Use mipLevel1x1 instead.

* @param {Number} value - The level.

setMipLevel1x1(value: number): void;

/**

* The delta time.

* @type {Number}

set deltaTime(arg: number);

/**

* Sets the delta time.

* @deprecated Use deltaTime instead.

* @param {Number} value - The delta time.

setDeltaTime(value: number): void;

set minLuminance(arg: number);

/**

* The lowest possible luminance value.

* @type {Number}

get minLuminance(): number;

/**

* Returns the lowest possible luminance value.

* @deprecated Use minLuminance instead.

* @return {Number} The minimum luminance.

getMinLuminance(): number;

/**

* Sets the minimum luminance.

* @deprecated Use minLuminance instead.

* @param {Number} value - The minimum luminance.

setMinLuminance(value: number): void;

set adaptationRate(arg: number);

/**

* The luminance adaptation rate.

* @type {Number}

get adaptationRate(): number;

/**

* Returns the luminance adaptation rate.

* @deprecated Use adaptationRate instead.

* @return {Number} The adaptation rate.

getAdaptationRate(): number;

/**

* Sets the luminance adaptation rate.

* @deprecated Use adaptationRate instead.

* @param {Number} value - The adaptation rate.

setAdaptationRate(value: number): void;

}

/**

* A bokeh disc blur material.

* This material should be applied twice in a row, with `fill` mode enabled for the second pass. Enabling the

* `foreground` option causes the shader to combine the near and far CoC values around foreground objects.

* @implements {Resizable}

export class BokehMaterial extends ShaderMaterial implements Resizable {

/**

* Constructs a new bokeh material.

* @param {Boolean} [fill=false] - Enables or disables the bokeh highlight fill mode.

* @param {Boolean} [foreground=false] - Determines whether this material will be applied to foreground colors.

constructor(fill?: boolean, foreground?: boolean);

/**

* The input buffer.

* @type {Texture}

set inputBuffer(arg: Texture);

/**

* Sets the input buffer.

* @deprecated Use inputBuffer instead.

* @param {Texture} value - The buffer.

setInputBuffer(value: Texture): void;

/**

* The circle of confusion buffer.

* @type {Texture}

set cocBuffer(arg: Texture);

/**

* Sets the circle of confusion buffer.

* @deprecated Use cocBuffer instead.

* @param {Texture} value - The buffer.

setCoCBuffer(value: Texture): void;

set scale(arg: number);

/**

* The blur scale.

* @type {Number}

get scale(): number;

/**

* Returns the blur scale.

* @deprecated Use scale instead.

* @return {Number} The scale.

getScale(value: number): number;

/**

* Sets the blur scale.

* @deprecated Use scale instead.

* @param {Number} value - The scale.

setScale(value: number): void;

/**

* Sets the texel size.

* @deprecated Use setSize() instead.

* @param {Number} x - The texel width.

* @param {Number} y - The texel height.

setTexelSize(x: number, y: number): void;

/**

* Sets the size of this object.

* @param {Number} width - The width.

* @param {Number} height - The height.

setSize(width: number, height: number): void;

}

/**

* A Circle of Confusion shader material.

export class CircleOfConfusionMaterial extends ShaderMaterial {

/**

* Constructs a new CoC material.

* @param {Camera} camera - A camera.

constructor(camera: Camera);

/**

* The depth buffer.

* @type {Texture}

set depthBuffer(arg: Texture);

/**

* The depth packing strategy.

* @type {DepthPackingStrategies}

set depthPacking(arg: DepthPackingStrategies);

/**

* Sets the depth buffer.

* @deprecated Use depthBuffer and depthPacking instead.

* @param {Texture} buffer - The depth texture.

* @param {DepthPackingStrategies} [depthPacking=BasicDepthPacking] - The depth packing strategy.

setDepthBuffer(

buffer: Texture,

depthPacking?: DepthPackingStrategies

): void;

set focusDistance(arg: number);

/**

* The focus distance. Range: [0.0, 1.0].

* @type {Number}

get focusDistance(): number;

/**

* Returns the focus distance.

* @deprecated Use focusDistance instead.

* @return {Number} The focus distance.

getFocusDistance(value: number): number;

/**

* Sets the focus distance.

* @deprecated Use focusDistance instead.

* @param {Number} value - The focus distance.

setFocusDistance(value: number): void;

set focalLength(arg: number);

/**

* The focal length.

* @deprecated Renamed to focusRange.

* @type {Number}

get focalLength(): number;

/**

* Returns the focal length.

* @deprecated Use focusRange instead.

* @return {Number} The focal length.

getFocalLength(value: number): number;

/**

* Sets the focal length.

* @deprecated Use focusRange instead.

* @param {Number} value - The focal length.

setFocalLength(value: number): void;

/**

* Adopts the settings of the given camera.

* @param {Camera} camera - A camera.

adoptCameraSettings(camera: Camera): void;

/**

* The focus distance in world units.

* @type {Number}

get worldFocusDistance(): number;

set worldFocusDistance(value: number);

/**

* The focus range. Range: [0.0, 1.0].

* @type {Number}

get focusRange(): number;

set focusRange(value: number);

/**

* The focus range in world units.

* @type {Number}

get worldFocusRange(): number;

set worldFocusRange(value: number);

}

/**

* A blur kernel size enumeration.

* @type {Object}

* @property {Number} VERY_SMALL - A very small kernel that matches a 7x7 Gaussian blur kernel.

* @property {Number} SMALL - A small kernel that matches a 15x15 Gaussian blur kernel.

* @property {Number} MEDIUM - A medium sized kernel that matches a 23x23 Gaussian blur kernel.

* @property {Number} LARGE - A large kernel that matches a 35x35 Gaussian blur kernel.

* @property {Number} VERY_LARGE - A very large kernel that matches a 63x63 Gaussian blur kernel.

* @property {Number} HUGE - A huge kernel that matches a 127x127 Gaussian blur kernel.

export enum KernelSize {

VERY_SMALL,

SMALL,

MEDIUM,

LARGE,

VERY_LARGE,

HUGE,

}

/**

* A simple copy shader material.

export class CopyMaterial extends ShaderMaterial {

/**

* Constructs a new copy material.

constructor();

/**

* The input buffer.

* @type {Texture}

set inputBuffer(arg: Texture);

/**

* Sets the input buffer.

* @deprecated Use inputBuffer instead.

* @param {Number} value - The buffer.

setInputBuffer(value: number): void;

/**

* Returns the opacity.

* @deprecated Use opacity instead.

* @return {Number} The opacity.

getOpacity(): number;

/**

* Sets the opacity.

* @deprecated Use opacity instead.

* @param {Number} value - The opacity.

setOpacity(value: number): void;

}

/**

* A depth comparison shader material.

export class DepthComparisonMaterial extends ShaderMaterial {

/**

* Constructs a new depth comparison material.

* @param {Texture} [depthTexture=null] - A depth texture.

* @param {PerspectiveCamera} [camera] - A camera.

constructor(depthTexture?: Texture, camera?: PerspectiveCamera);

/**

* The depth buffer.

* @type {Texture}

set depthBuffer(arg: Texture);

/**

* The depth packing strategy.

* @type {DepthPackingStrategies}

set depthPacking(arg: DepthPackingStrategies);

/**

* Sets the depth buffer.

* @deprecated Use depthBuffer and depthPacking instead.

* @param {Texture} buffer - The depth texture.

* @param {DepthPackingStrategies} [depthPacking=RGBADepthPacking] - The depth packing strategy.

setDepthBuffer(

buffer: Texture,

depthPacking?: DepthPackingStrategies

): void;

/**

* Adopts the settings of the given camera.

* @param {Camera} camera - A camera.

adoptCameraSettings(camera: Camera): void;

}

/**

* An enumeration of depth copy modes.

* @type {Object}

* @property {Number} FULL - Copies the full depth texture every frame.

* @property {Number} SINGLE - Copies a single texel from the depth texture on demand.

export enum DepthCopyMode {

FULL,

SINGLE,

}

/**

* A depth copy shader material.

export class DepthCopyMaterial extends ShaderMaterial {

/**

* Constructs a new depth copy material.

constructor();

/**

* The input depth buffer.

* @type {Texture}

set depthBuffer(arg: Texture);

/**

* The input depth packing strategy.

* @type {DepthPackingStrategies}

set inputDepthPacking(arg: DepthPackingStrategies);

set outputDepthPacking(arg: DepthPackingStrategies);

/**

* The output depth packing strategy.

* @type {DepthPackingStrategies}

get outputDepthPacking(): DepthPackingStrategies;

/**

* Sets the input depth buffer.

* @deprecated Use depthBuffer and inputDepthPacking instead.

* @param {Texture} buffer - The depth texture.

* @param {DepthPackingStrategies} [depthPacking=BasicDepthPacking] - The depth packing strategy.

setDepthBuffer(

buffer: Texture,

depthPacking?: DepthPackingStrategies

): void;

/**

* Returns the current input depth packing strategy.

* @deprecated

* @return {DepthPackingStrategies} The input depth packing strategy.

getInputDepthPacking(): DepthPackingStrategies;

/**

* Sets the input depth packing strategy.

* @deprecated Use inputDepthPacking instead.

* @param {DepthPackingStrategies} value - The new input depth packing strategy.

setInputDepthPacking(value: DepthPackingStrategies): void;

/**

* Returns the current output depth packing strategy.

* @deprecated Use outputDepthPacking instead.

* @return {DepthPackingStrategies} The output depth packing strategy.

getOutputDepthPacking(): DepthPackingStrategies;

/**

* Sets the output depth packing strategy.

* @deprecated Use outputDepthPacking instead.

* @param {DepthPackingStrategies} value - The new output depth packing strategy.

setOutputDepthPacking(value: DepthPackingStrategies): void;

/**

* The screen space position used for single-texel copy operations.

* @type {Vector2}

get texelPosition(): Vector2;

/**

* Returns the screen space position used for single-texel copy operations.

* @deprecated Use texelPosition instead.

* @return {Vector2} The position.

getTexelPosition(): Vector2;

/**

* Sets the screen space position used for single-texel copy operations.

* @deprecated

* @param {Vector2} value - The position.

setTexelPosition(value: Vector2): void;

set mode(arg: DepthCopyMode);

/**

* The depth copy mode.

* @type {DepthCopyMode}

get mode(): DepthCopyMode;

/**

* Returns the depth copy mode.

* @deprecated Use mode instead.

* @return {DepthCopyMode} The depth copy mode.

getMode(): DepthCopyMode;

/**

* Sets the depth copy mode.

* @deprecated Use mode instead.

* @param {DepthCopyMode} value - The new mode.

setMode(value: DepthCopyMode): void;

}

/**

* A depth downsampling shader material.

* Based on an article by Eleni Maria Stea:

* https://eleni.mutantstargoat.com/hikiko/depth-aware-upsampling-6

* @implements {Resizable}

export class DepthDownsamplingMaterial

extends ShaderMaterial

implements Resizable

{

/**

* Constructs a new depth downsampling material.

constructor();

/**

* The depth buffer.

* @type {Texture}

set depthBuffer(arg: Texture);

/**

* The depth packing strategy.

* @type {DepthPackingStrategies}

set depthPacking(arg: DepthPackingStrategies);

/**

* Sets the depth buffer.

* @deprecated Use depthBuffer and depthPacking instead.

* @param {Texture} buffer - The depth texture.

* @param {DepthPackingStrategies} [depthPacking=BasicDepthPacking] - The depth packing strategy.

setDepthBuffer(

buffer: Texture,

depthPacking?: DepthPackingStrategies

): void;

/**

* The normal buffer.

* @type {Texture}

set normalBuffer(arg: Texture);

/**

* Sets the normal buffer.

* @deprecated Use normalBuffer instead.

* @param {Texture} value - The normal buffer.

setNormalBuffer(value: Texture): void;

/**

* Sets the texel size.

* @deprecated Use setSize() instead.

* @param {Number} x - The texel width.

* @param {Number} y - The texel height.

setTexelSize(x: number, y: number): void;

/**

* Sets the size of this object.

* @param {Number} width - The width.

* @param {Number} height - The height.

setSize(width: number, height: number): void;

}

/**

* An enumeration of depth test strategies.

* @type {Object}

* @property {Number} DEFAULT - Perform depth test only.

* @property {Number} KEEP_MAX_DEPTH - Always keep max depth.

* @property {Number} DISCARD_MAX_DEPTH - Always discard max depth.

export enum DepthTestStrategy {

DEFAULT,

KEEP_MAX_DEPTH,

DISCARD_MAX_DEPTH,

}

/**

* A depth mask shader material.

* This material masks a color buffer by comparing two depth textures.

export class DepthMaskMaterial extends ShaderMaterial {

/**

* Constructs a new depth mask material.

constructor();

set depthMode(arg: DepthModes);

/**

* The depth mode.

* @see https://threejs.org/docs/#api/en/constants/Materials

* @type {DepthModes}

get depthMode(): DepthModes;

/**

* The primary depth buffer.

* @type {Texture}

set depthBuffer0(arg: Texture);

/**

* The primary depth packing strategy.

* @type {DepthPackingStrategies}

set depthPacking0(arg: DepthPackingStrategies);

/**

* Sets the base depth buffer.

* @deprecated Use depthBuffer0 and depthPacking0 instead.

* @param {Texture} buffer - The depth texture.

* @param {DepthPackingStrategies} [depthPacking=BasicDepthPacking] - The depth packing strategy.

setDepthBuffer0(

buffer: Texture,

depthPacking?: DepthPackingStrategies

): void;

/**

* The secondary depth buffer.

* @type {Texture}

set depthBuffer1(arg: Texture);

/**

* The secondary depth packing strategy.

* @type {DepthPackingStrategies}

set depthPacking1(arg: DepthPackingStrategies);

/**

* Sets the depth buffer that will be compared with the base depth buffer.

* @deprecated Use depthBuffer1 and depthPacking1 instead.

* @param {Texture} buffer - The depth texture.

* @param {DepthPackingStrategies} [depthPacking=BasicDepthPacking] - The depth packing strategy.

setDepthBuffer1(

buffer: Texture,

depthPacking?: DepthPackingStrategies

): void;

set maxDepthStrategy(arg: DepthTestStrategy);

/**

* The strategy for handling maximum depth.

* @type {DepthTestStrategy}

get maxDepthStrategy(): DepthTestStrategy;

set keepFar(arg: boolean);

/**

* Indicates whether maximum depth values should be preserved.

* @type {Boolean}

* @deprecated Use maxDepthStrategy instead.

get keepFar(): boolean;

/**

* Returns the strategy for dealing with maximum depth values.

* @deprecated Use maxDepthStrategy instead.

* @return {DepthTestStrategy} The strategy.

getMaxDepthStrategy(): DepthTestStrategy;

/**

* Sets the strategy for dealing with maximum depth values.

* @deprecated Use maxDepthStrategy instead.

* @param {DepthTestStrategy} value - The strategy.

setMaxDepthStrategy(value: DepthTestStrategy): void;

set epsilon(arg: number);

/**

* A small error threshold that is used for `EqualDepth` and `NotEqualDepth` tests. Default is `1e-5`.

* @type {Number}

get epsilon(): number;

/**

* Returns the current error threshold for depth comparisons. Default is `1e-5`.

* @deprecated Use epsilon instead.

* @return {Number} The error threshold.

getEpsilon(): number;

/**

* Sets the depth comparison error threshold.

* @deprecated Use epsilon instead.

* @param {Number} value - The new error threshold.

setEpsilon(value: number): void;

/**

* Returns the current depth mode.

* @deprecated Use depthMode instead.

* @return {DepthModes} The depth mode. Default is `LessDepth`.

getDepthMode(): DepthModes;

/**

* Sets the depth mode.

* @deprecated Use depthMode instead.

* @param {DepthModes} mode - The depth mode.

setDepthMode(mode: DepthModes): void;

}

/**

* An enumeration of edge detection modes.

* @type {Object}

* @property {Number} DEPTH - Depth-based edge detection.

* @property {Number} LUMA - Luminance-based edge detection.

* @property {Number} COLOR - Chroma-based edge detection.

export enum EdgeDetectionMode {

DEPTH,

LUMA,

COLOR,

}

/**

* An enumeration of predication modes.

* @type {Object}

* @property {Number} DISABLED - No predicated thresholding.

* @property {Number} DEPTH - Depth-based predicated thresholding.

* @property {Number} CUSTOM - Predicated thresholding using a custom buffer.

export enum PredicationMode {

DISABLED,

DEPTH,

CUSTOM,

}

/**

* An edge detection material.

* Mainly used for Subpixel Morphological Anti-Aliasing.

* @implements {Resizable}

export class EdgeDetectionMaterial

extends ShaderMaterial

implements Resizable

{

/**

* Constructs a new edge detection material.

* TODO Remove parameters.

* @param {Vector2} [texelSize] - The screen texel size.

* @param {EdgeDetectionMode} [mode=EdgeDetectionMode.COLOR] - The edge detection mode.

constructor(texelSize?: Vector2, mode?: EdgeDetectionMode);

set edgeDetectionMode(arg: EdgeDetectionMode);

/**

* The edge detection mode.

* @type {EdgeDetectionMode}

get edgeDetectionMode(): EdgeDetectionMode;

/**

* The depth buffer.

* @type {Texture}

set depthBuffer(arg: Texture);

/**

* The depth packing strategy.

* @type {DepthPackingStrategies}

set depthPacking(arg: DepthPackingStrategies);

/**

* Sets the depth buffer.

* @deprecated Use depthBuffer and depthPacking instead.

* @param {Texture} buffer - The depth texture.

* @param {DepthPackingStrategies} [depthPacking=BasicDepthPacking] - The depth packing strategy.

setDepthBuffer(

buffer: Texture,

depthPacking?: DepthPackingStrategies

): void;

/**

* Returns the edge detection mode.

* @deprecated Use edgeDetectionMode instead.

* @return {EdgeDetectionMode} The mode.

getEdgeDetectionMode(): EdgeDetectionMode;

/**

* Sets the edge detection mode.

* @deprecated Use edgeDetectionMode instead.

* @param {EdgeDetectionMode} value - The edge detection mode.

setEdgeDetectionMode(value: EdgeDetectionMode): void;

set localContrastAdaptationFactor(arg: number);

/**

* The local contrast adaptation factor. Has no effect if the edge detection mode is set to DEPTH. Default is 2.0.

* If a neighbor edge has _factor_ times bigger contrast than the current edge, the edge will be discarded.

* This allows to eliminate spurious crossing edges and is based on the fact that if there is too much contrast in a

* direction, the perceptual contrast in the other neighbors will be hidden.

* @type {Number}

get localContrastAdaptationFactor(): number;

/**

* Returns the local contrast adaptation factor.

* @deprecated Use localContrastAdaptationFactor instead.

* @return {Number} The factor.

getLocalContrastAdaptationFactor(): number;

/**

* Sets the local contrast adaptation factor. Has no effect if the edge detection mode is set to DEPTH.

* @deprecated Use localContrastAdaptationFactor instead.

* @param {Number} value - The local contrast adaptation factor. Default is 2.0.

setLocalContrastAdaptationFactor(value: number): void;

set edgeDetectionThreshold(arg: number);

/**

* The edge detection threshold. Range: [0.0, 0.5].

* A lower value results in more edges being detected at the expense of performance.

* For luma- and chroma-based edge detection, 0.1 is a reasonable value and allows to catch most visible edges. 0.05

* is a rather overkill value that allows to catch 'em all. Darker scenes may require an even lower threshold.

* If depth-based edge detection is used, the threshold will depend on the scene depth.

* @type {Number}

get edgeDetectionThreshold(): number;

/**

* Returns the edge detection threshold.

* @deprecated Use edgeDetectionThreshold instead.

* @return {Number} The threshold.

getEdgeDetectionThreshold(): number;

/**

* Sets the edge detection threshold.

* @deprecated Use edgeDetectionThreshold instead.

* @param {Number} value - The edge detection threshold. Range: [0.0, 0.5].

setEdgeDetectionThreshold(value: number): void;

set predicationMode(arg: PredicationMode);

/**

* The predication mode.

* Predicated thresholding allows to better preserve texture details and to improve edge detection using an additional

* buffer such as a light accumulation or depth buffer.

* @type {PredicationMode}

get predicationMode(): PredicationMode;

/**

* Returns the predication mode.

* @deprecated Use predicationMode instead.

* @return {PredicationMode} The mode.

getPredicationMode(): PredicationMode;

/**

* Sets the predication mode.

* @deprecated Use predicationMode instead.

* @param {PredicationMode} value - The predication mode.

setPredicationMode(value: PredicationMode): void;

/**

* The predication buffer.

* @type {Texture}

set predicationBuffer(arg: Texture);

/**

* Sets a custom predication buffer.

* @deprecated Use predicationBuffer instead.

* @param {Texture} value - The predication buffer.

setPredicationBuffer(value: Texture): void;

set predicationThreshold(arg: number);

/**

* The predication threshold.

* @type {Number}

get predicationThreshold(): number;

/**

* Returns the predication threshold.

* @deprecated Use predicationThreshold instead.

* @return {Number} The threshold.

View remainder of file in raw view

postprocessing/types/postprocessing.d.ts at main · codeTCbin25/postprocessing · GitHub

Navigation Menu

Expand file tree

Breadcrumbs

postprocessing.d.ts

Latest commit

History

Breadcrumbs

postprocessing.d.ts

File metadata and controls

Footer

Footer navigation