Skip to content

Commit

Permalink
Replace @group with @category
Browse files Browse the repository at this point in the history
  • Loading branch information
vanruesc committed Jan 11, 2024
1 parent 3c054d8 commit d2b3029
Show file tree
Hide file tree
Showing 118 changed files with 154 additions and 128 deletions.
2 changes: 1 addition & 1 deletion src/core/BaseEventMap.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { BaseEvent } from "three";
/**
* Common events.
*
* @group Core
* @category Core
*/

export interface BaseEventMap {
Expand Down
2 changes: 1 addition & 1 deletion src/core/Disposable.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Describes objects that can free internal resources.
*
* @group Core
* @category Core
*/

export interface Disposable {
Expand Down
2 changes: 1 addition & 1 deletion src/core/IOManager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { Output } from "./Output.js";
/**
* An I/O manager.
*
* @group Core
* @category Core
*/

export class IOManager {
Expand Down
2 changes: 1 addition & 1 deletion src/core/Input.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { ShaderData } from "./ShaderData.js";
*
* Listen for events of type {@link EVENT_CHANGE} to react to resource updates.
*
* @group Core
* @category Core
*/

export class Input extends EventDispatcher<BaseEventMap> implements ShaderData {
Expand Down
2 changes: 1 addition & 1 deletion src/core/Output.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { ShaderData } from "./ShaderData.js";
*
* Listen for events of type {@link EVENT_CHANGE} to react to resource updates.
*
* @group Core
* @category Core
*/

export class Output extends EventDispatcher<BaseEventMap> implements ShaderData {
Expand Down
6 changes: 3 additions & 3 deletions src/core/Pass.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import { Renderable } from "./Renderable.js";
/**
* An abstract pass.
*
* @group Core
* @category Core
*/

export abstract class Pass<TMaterial extends Material | null = null>
Expand Down Expand Up @@ -408,9 +408,9 @@ export abstract class Pass<TMaterial extends Material | null = null>
}

/**
* Checks if his pass uses convolution shaders.
* Checks if this pass uses convolution shaders.
*
* Only works on passes that use `FullscreenMaterial`.
* Only works on passes that use a `FullscreenMaterial`.
*
* @param recursive - Controls whether subpasses should be checked recursively.
* @return True if the pass uses convolution shaders.
Expand Down
2 changes: 1 addition & 1 deletion src/core/RenderPipeline.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const v = /* @__PURE__ */ new Vector2();
/**
* A render pipeline that can be used to group and run passes.
*
* @group Core
* @category Core
*/

export class RenderPipeline implements Disposable, Renderable, Resizable {
Expand Down
2 changes: 1 addition & 1 deletion src/core/Renderable.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Describes objects that can perform render operations.
*
* @group Core
* @category Core
*/

export interface Renderable {
Expand Down
2 changes: 1 addition & 1 deletion src/core/Resizable.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Describes objects that can be resized.
*
* @group Core
* @category Core
*/

export interface Resizable {
Expand Down
2 changes: 1 addition & 1 deletion src/core/Selective.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Selection } from "../utils/Selection.js";
/**
* Describes objects that can operate on a selection of objects.
*
* @group Core
* @category Core
*/

export interface Selective {
Expand Down
2 changes: 1 addition & 1 deletion src/core/ShaderData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Uniform } from "three";
/**
* Basic shader data.
*
* @group Core
* @category Core
*/

export interface ShaderData {
Expand Down
2 changes: 1 addition & 1 deletion src/effects/Effect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { BlendMode } from "./blending/BlendMode.js";
*
* Effects are subpasses that can be merged using the {@link EffectPass}.
*
* @group Effects
* @category Effects
*/

export abstract class Effect extends Pass {
Expand Down
2 changes: 2 additions & 0 deletions src/effects/FXAAEffect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import vertexShader from "./shaders/fxaa.vert";
*
* Based on an implementation by Simon Rodriguez:
* https://github.com/kosua20/Rendu/blob/master/resources/common/shaders/screens/fxaa.frag
*
* @category Effects
*/

export class FXAAEffect extends Effect {
Expand Down
4 changes: 4 additions & 0 deletions src/effects/ToneMappingEffect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import fragmentShader from "./shaders/tone-mapping.frag";

/**
* ToneMappingEffect options.
*
* @category Effects
*/

export interface ToneMappingEffectOptions {
Expand All @@ -19,6 +21,8 @@ export interface ToneMappingEffectOptions {

/**
* A tone mapping effect.
*
* @category Effects
*/

export class ToneMappingEffect extends Effect {
Expand Down
4 changes: 4 additions & 0 deletions src/effects/VignetteEffect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ import fragmentShader from "./shaders/vignette.frag";

/**
* VignetteEffect options.
*
* @category Effects
*/

export interface VignetteEffectOptions {
Expand Down Expand Up @@ -38,6 +40,8 @@ export interface VignetteEffectOptions {

/**
* A vignette effect.
*
* @category Effects
*/

export class VignetteEffect extends Effect {
Expand Down
2 changes: 1 addition & 1 deletion src/effects/blending/BlendFunction.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* An abstract blend function.
*
* @group Blending
* @category Blending
*/

export abstract class BlendFunction {
Expand Down
4 changes: 2 additions & 2 deletions src/effects/blending/BlendMode.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { BlendFunction } from "./BlendFunction.js";
/**
* BlendMode events.
*
* @group Blending
* @category Blending
*/

export interface BlendModeEventMap {
Expand All @@ -16,7 +16,7 @@ export interface BlendModeEventMap {
/**
* A blend mode.
*
* @group Blending
* @category Blending
*/

export class BlendMode extends EventDispatcher<BlendModeEventMap> {
Expand Down
2 changes: 1 addition & 1 deletion src/effects/blending/blend-functions/AddBlendFunction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/add.frag";
/**
* Additive blending. Supports HDR.
*
* @group Blending
* @category Blending
*/

export class AddBlendFunction extends BlendFunction {
Expand Down
2 changes: 1 addition & 1 deletion src/effects/blending/blend-functions/AlphaBlendFunction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/alpha.frag";
/**
* Blends based on the alpha value of the new color. Supports HDR.
*
* @group Blending
* @category Blending
*/

export class AlphaBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/average.frag";
/**
* Calculates the average of the new color and the base color. Supports HDR.
*
* @group Blending
* @category Blending
*/

export class AverageBlendFunction extends BlendFunction {
Expand Down
2 changes: 1 addition & 1 deletion src/effects/blending/blend-functions/ColorBlendFunction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/color.frag";
/**
* Converts the colors to HSL and blends based on color.
*
* @group Blending
* @category Blending
*/

export class ColorBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/color-burn.frag";
/**
* Color burn.
*
* @group Blending
* @category Blending
*/

export class ColorBurnBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/color-dodge.frag";
/**
* Color dodge.
*
* @group Blending
* @category Blending
*/

export class ColorDodgeBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/darken.frag";
/**
* Prioritizes darker colors. Supports HDR.
*
* @group Blending
* @category Blending
*/

export class DarkenBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/difference.frag";
/**
* Color difference. Supports HDR.
*
* @group Blending
* @category Blending
*/

export class DifferenceBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/divide.frag";
/**
* Color division. Supports HDR.
*
* @group Blending
* @category Blending
*/

export class DivideBlendFunction extends BlendFunction {
Expand Down
2 changes: 1 addition & 1 deletion src/effects/blending/blend-functions/DstBlendFunction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { BlendFunction } from "../BlendFunction.js";
/**
* Overwrites the new color with the base color and ignores opacity. Supports HDR.
*
* @group Blending
* @category Blending
*/

export class DstBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/exclusion.frag";
/**
* Color exclusion.
*
* @group Blending
* @category Blending
*/

export class ExclusionBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/hard-light.frag";
/**
* Hard light.
*
* @group Blending
* @category Blending
*/

export class HardLightBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/hard-mix.frag";
/**
* Hard mix.
*
* @group Blending
* @category Blending
*/

export class HardMixBlendFunction extends BlendFunction {
Expand Down
2 changes: 1 addition & 1 deletion src/effects/blending/blend-functions/HueBlendFunction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/hue.frag";
/**
* Converts the colors to HSL and blends based on hue.
*
* @group Blending
* @category Blending
*/

export class HueBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/invert.frag";
/**
* Overwrites the base color with the inverted new color.
*
* @group Blending
* @category Blending
*/

export class InvertBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/invert-rgb.frag";
/**
* Multiplies the new color with the inverted base color.
*
* @group Blending
* @category Blending
*/

export class InvertRGBBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/lighten.frag";
/**
* Prioritizes lighter colors. Supports HDR.
*
* @group Blending
* @category Blending
*/

export class LightenBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/linear-burn.frag";
/**
* Linear burn.
*
* @group Blending
* @category Blending
*/

export class LinearBurnBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/linear-dodge.frag";
/**
* Same as add but limits the result to 1.
*
* @group Blending
* @category Blending
*/

export class LinearDodgeBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/linear-light.frag";
/**
* Linear light.
*
* @group Blending
* @category Blending
*/

export class LinearLightBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/luminosity.frag";
/**
* Converts the colors to HSL and blends based on luminosity.
*
* @group Blending
* @category Blending
*/

export class LuminosityBlendFunction extends BlendFunction {
Expand Down
2 changes: 1 addition & 1 deletion src/effects/blending/blend-functions/MixBlendFunction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/mix.frag";
/**
* Linearly interpolates from the base color to the new one. Supports HDR.
*
* @group Blending
* @category Blending
*/

export class MixBlendFunction extends BlendFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import shader from "./shaders/multiply.frag";
/**
* Color multiplication. Supports HDR.
*
* @group Blending
* @category Blending
*/

export class MultiplyBlendFunction extends BlendFunction {
Expand Down
Loading

0 comments on commit d2b3029

Please sign in to comment.