Skip to content

Commit

Permalink
chore: remove obsolete an non-functional prop disableRender (#838)
Browse files Browse the repository at this point in the history
* removed obsolete disableRender

* removed obsolete import
  • Loading branch information
Tinoooo committed Sep 23, 2024
1 parent 37df535 commit 5b6488d
Show file tree
Hide file tree
Showing 9 changed files with 0 additions and 16 deletions.
1 change: 0 additions & 1 deletion docs/api/tres-canvas.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ renderer.shadowMap.type = PCFSoftShadowMap
| **context** | This can be used to attach the renderer to an existing [RenderingContext](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext) | |
| **depth** | Whether the drawing buffer has a [depth buffer](https://en.wikipedia.org/wiki/Z-buffering) of at least 16 bits. | `true` |
| **renderMode** | Render mode, can be `always`, `on-demand` or `manual`. See [Performance](../advanced/performance) | `always` |
| **disableRender** | Disable render on requestAnimationFrame, useful for PostProcessing | `false` |
| **failIfMajorPerformanceCaveat** | Whether the renderer creation will fail upon low performance is detected. See [WebGL spec](https://registry.khronos.org/webgl/specs/latest/1.0/#5.2) for details. | `false` |
| **logarithmicDepthBuffer** | Whether to use a logarithmic depth buffer. It may be necessary to use this if dealing with huge differences in scale in a single scene. Note that this setting uses gl_FragDepth if available which disables the [Early Fragment Test](https://www.khronos.org/opengl/wiki/Early_Fragment_Test) optimization and can cause a decrease in performance. | `false` |
| **outputColorSpace** | Defines the output encoding | `LinearEncoding` |
Expand Down
1 change: 0 additions & 1 deletion docs/de/api/tres-canvas.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ renderer.shadowMap.type = PCFSoftShadowMap
| **clearColor** | Die Farbe, die der Renderer verwendet, um die Leinwand zu löschen. | `#000000` |
| **context** | Kann verwendet werden, um den Renderer an einen vorhandenen [RenderingContext](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext) anzuhängen. | |
| **depth** | Gibt an, ob der Zeichenpuffer einen [Tiefenpuffer](https://en.wikipedia.org/wiki/Z-buffering) von mindestens 16 Bit hat. | `true` |
| **disableRender** | Deaktiviert das Rendering in requestAnimationFrame, nützlich für PostProcessing. | `false` |
| **failIfMajorPerformanceCaveat** | Gibt an, ob die Erstellung des Renderers fehlschlagen soll, wenn eine geringe Performance festgestellt wird. Siehe die [WebGL-Spezifikation](https://registry.khronos.org/webgl/specs/latest/1.0/#5.2) für weitere Details. | `false` |
| **logarithmicDepthBuffer** | Gibt an, ob ein logarithmischer Tiefenpuffer verwendet werden soll. Dies kann notwendig sein, wenn in einer einzigen Szene enorme Skalendifferenzen gehandhabt werden müssen. Beachte, dass diese Einstellung gl_FragDepth verwendet, wenn verfügbar, was die Optimierung [Early Fragment Test](https://www.khronos.org/opengl/wiki/Early_Fragment_Test) deaktiviert und zu einer Performancesverminderung führen kann. | `false` |
| **outputColorSpace** | Definiert die Ausgabekodierung. | `LinearEncoding` |
Expand Down
1 change: 0 additions & 1 deletion docs/es/api/tres-canvas.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ renderer.shadowMap.type = PCFSoftShadowMap
| **clearColor** | El color que el renderizador utilizará para borrar el lienzo. | `#000000` |
| **context** | Esto se puede usar para adjuntar el renderizador a un [RenderingContext](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext) existente. | |
| **depth** | Indica si el búfer de dibujo tiene un [búfer de profundidad](https://en.wikipedia.org/wiki/Z-buffering) de al menos 16 bits. | `true` |
| **disableRender** | Desactiva el renderizado en requestAnimationFrame, útil para PostProcessing. | `false` |
| **failIfMajorPerformanceCaveat** | Indica si la creación del renderizador fallará si se detecta un bajo rendimiento. Consulta la [especificación de WebGL](https://registry.khronos.org/webgl/specs/latest/1.0/#5.2) para más detalles. | `false` |
| **logarithmicDepthBuffer** | Indica si se debe utilizar un búfer de profundidad logarítmico. Puede ser necesario utilizar esto si se manejan diferencias enormes de escala en una sola escena. Ten en cuenta que esta configuración utiliza gl_FragDepth si está disponible, lo cual deshabilita la optimización [Early Fragment Test](https://www.khronos.org/opengl/wiki/Early_Fragment_Test) y puede causar una disminución en el rendimiento. | `false` |
| **outputColorSpace** | Define la codificación de salida. | `LinearEncoding` |
Expand Down
1 change: 0 additions & 1 deletion docs/fr/api/tres-canvas.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ renderer.shadowMap.type = PCFSoftShadowMap
| **clearColor** | La couleur que le moteur de rendu utilisera pour effacer le canevas. | `#000000` |
| **context** | Ceci peut être utilisé pour attacher le moteur de rendu à un [RenderingContext](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext) existente. | |
| **depth** | Indique si le tampon de dessin a une [profondeur du tampon](https://en.wikipedia.org/wiki/Z-buffering) de au moins 16 bits. | `true` |
| **disableRender** | Désactive le rendu sur requestAnimationFrame, utile pour le post-traitement. | `false` |
| **failIfMajorPerformanceCaveat** | Indique si la création du moteur de rendu échouera si de mauvaises performances sont détectées. Voir la [spécification WebGL](https://registry.khronos.org/webgl/specs/latest/1.0/#5.2) para más detalles. | `false` |
| **logarithmicDepthBuffer** | Indique s’il faut utiliser un tampon de profondeur logarithmique. Il peut être nécessaire de l'utiliser s'il s'agit de différences d'échelle énormes dans une seule scène. Notez que ce paramètre utilise gl_FragDepth s'il est disponible, ce qui désactive l'optimisation [Early Fragment Test](https://www.khronos.org/opengl/wiki/Early_Fragment_Test) et peut entraîner une baisse des performances. | `false` |
| **outputColorSpace** | Définit l'encodage de sortie. | `LinearEncoding` |
Expand Down
1 change: 0 additions & 1 deletion docs/nl/api/tres-canvas.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ renderer.shadowMap.type = PCFSoftShadowMap
| **clearColor** | De kleur die de renderer gebruikt om het canvas leeg te maken. | `#000000` |
| **context** | Dit kan worden gebruikt om de renderer aan een bestaand [RenderingContext](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext) te koppelen | |
| **depth** | Of de drawing buffer een [depth buffer](https://en.wikipedia.org/wiki/Z-buffering) heeft van tenminste 16 bits. | `true` |
| **disableRender** | Blokkeer render op requestAnimationFrame, handig voor PostProcessing | `false` |
| **failIfMajorPerformanceCaveat** | Er wordt gedetecteerd of het maken van de renderer zal mislukken bij lage prestaties. Zie [WebGL spec](https://registry.khronos.org/webgl/specs/latest/1.0/#5.2) for details. | `false` |
| **logarithmicDepthBuffer** | Of de logarithmic depth buffer gebruikt moet worden. Het kan zijn dat dit noodzakelijk is als je te maken hebt met flinke verschillen in scale in een enkele scene. Merk op dat deze setting gebruik maakt van gl_FragDepth wanneer deze beschikbaar is en deze schakelt [Early Fragment Test](https://www.khronos.org/opengl/wiki/Early_Fragment_Test) uit en kan een verlies in prestaties veroorzaken. | `false` |
| **outputColorSpace** | Definieert de uitvoercodering | `LinearEncoding` |
Expand Down
1 change: 0 additions & 1 deletion docs/zh/api/tres-canvas.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ renderer.shadowMap.type = PCFSoftShadowMap
| **clearColor** | 清除画布后渲染器显示颜色。 | `#000000` |
| **context** | 将渲染器附加到现有的 [RenderingContext](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext) | |
| **depth** | 绘图缓冲区是否至少具有16位的[深度缓冲区](https://en.wikipedia.org/wiki/Z-buffering)| `true` |
| **disableRender** | 禁用 `requestAnimationFrame` 上的渲染,这对于后期处理非常有用。 | `false` |
| **failIfMajorPerformanceCaveat** | 在性能较低时,是否检测渲染器创建失败。详细信息请参阅[WebGL](https://registry.khronos.org/webgl/specs/latest/1.0/#5.2)规范。 | `false` |
| **logarithmicDepthBuffer** | 是否使用深度缓冲区。如果在单个场景中处理巨大的比例差异,可能需要使用此选项。请注意,如果使用,此设置将使用gl_FragDepth,这将禁用[Early Fragment Test](https://www.khronos.org/opengl/wiki/Early_Fragment_Test)优化,可能会导致性能下降。 | `false` |
| **outputColorSpace** | 定义输出编码 | `LinearEncoding` |
Expand Down
6 changes: 0 additions & 6 deletions src/components/TresCanvas.vue
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import { PerspectiveCamera, Scene } from 'three'
import * as THREE from 'three'
import {
computed,
createRenderer,
defineComponent,
Fragment,
Expand Down Expand Up @@ -55,7 +54,6 @@ export interface TresCanvasProps
camera?: TresCamera
preset?: RendererPresetsType
windowSize?: boolean
disableRender?: boolean
}
const props = withDefaults(defineProps<TresCanvasProps>(), {
Expand All @@ -65,7 +63,6 @@ const props = withDefaults(defineProps<TresCanvasProps>(), {
stencil: undefined,
antialias: undefined,
windowSize: undefined,
disableRender: undefined,
useLegacyLights: undefined,
preserveDrawingBuffer: undefined,
logarithmicDepthBuffer: undefined,
Expand Down Expand Up @@ -143,8 +140,6 @@ const dispose = (context: TresContext, force = false) => {
}
}
const disableRender = computed(() => props.disableRender)
const context = shallowRef<TresContext | null>(null)
defineExpose({ context, dispose: () => dispose(context.value as TresContext, true) })
Expand All @@ -166,7 +161,6 @@ onMounted(() => {
scene: scene.value as TresScene,
canvas: existingCanvas,
windowSize: props.windowSize ?? false,
disableRender: disableRender.value ?? false,
rendererOptions: props,
emit,
})
Expand Down
1 change: 0 additions & 1 deletion src/composables/useRenderer/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@ export function useRenderer(
options: UseRendererOptions
emit: EmitEventFn
contextParts: Pick<TresContext, 'sizes' | 'camera' | 'render'> & { invalidate: () => void, advance: () => void }
disableRender: MaybeRefOrGetter<boolean>
},
) {
const webGLRendererConstructorParameters = computed<WebGLRendererParameters>(() => ({
Expand Down
3 changes: 0 additions & 3 deletions src/composables/useTresContextProvider/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,12 @@ export function useTresContextProvider({
scene,
canvas,
windowSize,
disableRender,
rendererOptions,
emit,
}: {
scene: TresScene
canvas: MaybeRef<HTMLCanvasElement>
windowSize: MaybeRefOrGetter<boolean>
disableRender: MaybeRefOrGetter<boolean>
rendererOptions: UseRendererOptions
emit: EmitEventFn

Expand Down Expand Up @@ -141,7 +139,6 @@ export function useTresContextProvider({
emit,
// TODO: replace contextParts with full ctx at https://github.com/Tresjs/tres/issues/516
contextParts: { sizes, camera, render, invalidate, advance },
disableRender,
},
)

Expand Down

0 comments on commit 5b6488d

Please sign in to comment.