Skip to content

Commit b33db3f

Browse files
committed
Updated README.
1 parent 277c261 commit b33db3f

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -155,13 +155,27 @@ The extension also supports highlighting of compilation errors in the text edito
155155
![error example](https://raw.githubusercontent.com/stevensona/shader-toy/master/images/example3.png)
156156

157157
## Recording Capabilities
158-
The following settings allow to configure recording quality
158+
Two rendering modes are supported:
159+
* Realtime rendering: suitable for previews and scenarios where real-time interaction with the visuals are required. As with all real-time video capture, frame drops might occur, especially on lower spec hardware or when rendering very complex visuals.
160+
* Offline rendering: suitable for production-grade rendering. Each frame is rendered sequentially without any drops.
161+
162+
The default is real-time rendering to activate offline rendering set `shader-toy.recordOffline`to true.
163+
164+
### Shared parameters
165+
159166
* `shader-toy.forceResolution`: Set canvas resolution, this will also set the resolution of the recorded video file. By default, the canvas will stretch to fill the entire window.
167+
* `shader-toy.recordTargetFramerate`: Set recording target frame-rate. Default is 30fps.
168+
* `shader-toy.recordMaxDuration`: Maximum recording duration in seconds. 0 (the default) will keep recording until the record button is pressed again.
169+
170+
### Real-time Rendering parameters
171+
160172
* `shader-toy.recordVideoContainer`: Set the video file container. Currently only `webm` is supported, but `mp4`support is coming [soon](https://chromestatus.com/feature/5163469011943424).
161173
* `shader-toy.recordVideoCodec`: Set video codec. `vp8`, `vp9`, `h264` and `avc1` are all supported. Default it `vp8`.
162174
* `shader-toy.recordVideoBitRate`: Set recording bit rate in bits/second. Default is 2500000.
163-
* `shader-toy.recordTargetFramerate`: Set recording target frame-rate. Default is 30fps.
164-
* `shader-toy.recordMaxDuration`: Maximum recording duration in seconds. 0 (the default) will keep recording until the record button is pressed again.
175+
176+
### Offline rendering parameters
177+
178+
* `shader-toy.recordOfflineQuality`: Offline recording quality. Applies when format is webm or jpg.
165179

166180
## Requirements
167181

@@ -186,13 +200,15 @@ Contributions of any kind are welcome and encouraged.
186200
## Release Notes
187201

188202
### 0.11.4
189-
* Added `shader-toy.forceResolution` (force canvas resolution),
190-
* Added `shader-toy.recordVideoContainer` (set video file container),
191-
* Added `shader-toy.recordVideoCodec` (set video codec),
192-
* Added `shader-toy.recordVideoBitRate` (set recording bit rate),
193-
* Added `shader-toy.recordMaxDuration` (set maximum recording duration),
194-
* Fixed the `shader-toy.recordTargetFramerate` setting,
203+
* Added `shader-toy.forceResolution` (force canvas resolution).
204+
* Added `shader-toy.recordVideoContainer` (set video file container).
205+
* Added `shader-toy.recordVideoCodec` (set video codec).
206+
* Added `shader-toy.recordVideoBitRate` (set recording bit rate).
207+
* Added `shader-toy.recordMaxDuration` (set maximum recording duration).
208+
* Fixed the `shader-toy.recordTargetFramerate` setting.
195209
* Moved the Stats widget to the bottom left, so it doesn't overlap with the GUI.
210+
* Added `shader-toy.recordOffline` to switch between real-time and offline rendering.
211+
* Added `shader-toy.recordOfflineQuality`. Used in conjunction with `shader-toy.recordOffline`
196212

197213
### 0.11.3
198214
* Added option to reload on save,

0 commit comments

Comments
 (0)