File: system.rst

package info (click to toggle)
blender-doc 4.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 253,604 kB
  • sloc: python: 13,030; javascript: 322; makefile: 113; sh: 107
file content (292 lines) | stat: -rw-r--r-- 10,189 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
.. _bpy.types.PreferencesSystem:

******
System
******

The *System* section allows you to set graphics card options, memory limits & sound settings.

If your hardware does not support some of the options described on this page,
then they will either not be displayed or be corrected on startup.

.. figure:: /images/editors_preferences_section_system.png

   Preferences System section.


.. _editors_preferences_cycles:

Cycles Render Device
====================

Changes the computing device the :doc:`Cycles </render/cycles/index>` render engine uses to render images.
Cycles can use either the CPU or certain GPUs to render images,
for more information see the :doc:`GPU Rendering </render/cycles/gpu_rendering>` page.

:None:
   When set to *None* or when the only option is *None*:
   the CPU will be used as the computing device for Cycles.
:CUDA:
   If the system has a compatible Nvidia CUDA device, it will be available as an option for rendering with Cycles.
:OptiX:
   If the system has a compatible Nvidia OptiX device, it will be available as an option for rendering with Cycles.
:HIP:
   If the system has a compatible AMD HIP device, it will be available as an option for rendering with Cycles.
:oneAPI:
   If the system has a compatible Intel oneAPI device, it will be available as an option for rendering with Cycles.
:Metal:
   If the system has a compatible Apple Metal device, it will be available as an option for rendering with Cycles.

.. _prefs-system-cycles-distributive-memory:

Distribute Memory Across Devices
   Allocates resources across multiple GPUs rather than duplicating data,
   effectively freeing up space for larger scenes. Note that in order for this option to be available,
   the GPUs must be connected together with a high bandwidth communication protocol.

   Currently only NVLink on Nvidia GPUs is supported.

Embree on GPU
   Enables the use of hardware ray tracing on Intel GPUs, providing better overall performance.

   Only supported with oneAPI rendering devices..

HIP RT (Experimental)
   Speeds up rendering by enabling AMD hardware ray tracing on RDNA2 and above, with shader fallback on older cards.
   This feature is experimental and some scenes may render incorrectly.

   This feature is only available when using a *HIP* render device.

MetalRT
   MetalRT for ray tracing uses less memory for scenes which use curves extensively,
   and can give better performance in specific cases.

   :Off: Disable MetalRT (uses BVH2 layout for intersection queries).
   :On: Enable MetalRT for intersection queries.
   :Auto: Automatically pick the fastest intersection method.


Operating System Settings
=========================

Make this installation your default Blender (MS-Windows & Linux only).

On Linux, if Blender is installed from a package manager such as Snap,
file association is handled by the package manager.

.. _prefs-system-register:

Register
   Make the currently in use Blender installation the default
   for generating thumbnails and the default for opening blend-files.
Unregister
   Remove file association & thumbnailer.

For All Users
   Register Blender for all users, requires escalated privileges.


.. admonition:: Linux Registration
   :class: note

   Files are setup files under: ``/usr/local`` for all users, otherwise ``~/.local`` is used.

   - A desktop file & icon is installed so the application is available in launchers.
   - A file association for ``*.blend`` is setup.
   - The thumbnailer is installed so blend-file thumbnails will be shown in file managers (**For All Users** only).


Network
=======

.. _bpy.types.PreferencesSystem.use_online_access:

Allow Online Access
   Allow Blender to access the internet.

   Add-ons that follow this setting will only connect to the internet if enabled.
   However, Blender cannot prevent third-party add-ons from violating this rule.

Time Out
   The time (in seconds) that online operations may wait before timing out.

   Use the systems default when zero.

Connection Limit
   The maximum number of simultaneous connections an online operation may make.

   Do not limit the number of connections when zero.

.. _prefs-system-memory-and-limits:

Memory & Limits
===============

.. _bpy.types.PreferencesEdit.undo_steps:

Undo Steps
   Number of Undo steps available.

.. _bpy.types.PreferencesEdit.undo_memory_limit:

Undo Memory Limit
   Maximum memory usage in Mb (0 is unlimited).

.. _bpy.types.PreferencesEdit.use_global_undo:

Global Undo
   This enables Blender to save actions done when you are **not** in *Edit Mode*.
   For example, duplicating objects, changing panel settings or switching between modes.

   .. warning::

      While disabling this option does save memory,
      it stops the :ref:`bpy.ops.screen.redo_last` panel from functioning,
      also preventing tool options from being changed in some cases.
      For typical usage, its best to keep this enabled.

.. seealso::

   :doc:`Read more about Undo and Redo options </interface/undo_redo>`.

.. _bpy.types.PreferencesSystem.scrollback:

Console Scroll-back Lines
   The number of lines, buffered in memory of the console window.
   Useful for debugging purposes and command-line rendering.

.. _bpy.types.PreferencesSystem.texture_time_out:

Texture Time Out
   Time since last access of a GL texture in seconds, after which it is freed.
   Set this to 0 to keep textures allocated.

   .. _bpy.types.PreferencesSystem.texture_collection_rate:

   Garbage Collection Rate
      Number of seconds between each run of the GL texture garbage collector.

.. _bpy.types.PreferencesSystem.vbo_time_out:

VBO Time Out
   Time since last access of a GL vertex buffer object (VBO) in seconds after which it is freed
   (set to 0 to keep VBO allocated).

   .. _bpy.types.PreferencesSystem.vbo_collection_rate:

   Garbage Collection Rate
      Number of seconds between each run of the GL vertex buffer object garbage collector.


.. _prefs-system-video-sequencer:

Video Sequencer
===============

.. _bpy.types.PreferencesSystem.memory_cache_limit:

Memory Cache Limit
   Upper limit of the Video Sequencer and Movie Clip Editor memory cache (in megabytes).
   For an optimal Clip editor and Sequencer performance, high values are recommended.

.. _bpy.types.PreferencesSystem.use_sequencer_disk_cache:

Disk Cache
   Writes cached strips to disk which can store a lot more than RAM.
   To use the Disk Cache, this option must be enabled,
   the *Disk Cache Directory* and *Disk Cache Limit* set, then save or reopen the existing blend-file.

.. _bpy.types.PreferencesSystem.sequencer_disk_cache_dir:

Directory
   The location on disk to store the cache.

.. _bpy.types.PreferencesSystem.sequencer_disk_cache_size_limit:

Cache Limit
   Upper limit of the Video Sequencer's disk cache (in gigabytes), setting to zero disables disk cache.

.. _bpy.types.PreferencesSystem.sequencer_disk_cache_compression:

Compression
   The level of compression to compress image in the disk cache.
   This has a trade off between saving disk space and requiring more processing.
   The more compression used requires faster disk write/read speeds and more CPU usage.

.. _bpy.types.PreferencesSystem.sequencer_proxy_setup:

Proxy Setup
   When and how :doc:`Proxies </editors/video_sequencer/sequencer/sidebar/proxy>` are created.

   :Automatic: Build proxies for added movie and image strips in each preview size.
   :Manual: Set up proxies manually.

.. seealso::

   :doc:`Sequencer Cache Properties </editors/video_sequencer/sequencer/sidebar/cache>`


.. _prefs-system-sound:

Sound
=====

This panel contains the sound settings for live playback
within Blender and are only available with a device other than *None*.
To control these settings for exporting sound
see the :ref:`Encoding Panel <render-output-video-encoding-panel>`
and :ref:`Audio Panel <data-scenes-audio>`.

.. _bpy.types.PreferencesSystem.audio_device:

Audio Device
   Sets the audio engine to use to process and output audio.

   :None:
      No audio playback support (audio strips can still be loaded and rendered normally).
   :CoreAudio:
      On macOS, CoreAudio is the native audio API.
      This is the default setting for macOS users and should be preferred.
   :PulseAudio:
      PulseAudio is the most commonly used sound server on modern Linux distributions.
      If PulseAudio is available, this should be the preferred setting on Linux.
   :WASAPI:
      On Windows, WASAPI is the native audio API introduced with Windows Vista.
      This is the default setting for Windows users and should be preferred.
   :Jack:
      High quality professional audio engine that needs a properly configured server running on your system.
      Supports accurate synchronization with other professional audio applications using Jack.
   :OpenAL:
      Available on all platforms in case the native engines do not work.
      The played back 3D audio might sound different than when rendered.
   :SDL:
      Uses Simple Direct Media Layer API from `libsdl.org <https://www.libsdl.org>`__
      which supports all platforms. Might be of lower quality and thus should only be used as backup.

.. _bpy.types.PreferencesSystem.audio_channels:

Channels
   The number of audio source "locations" to output.

   :Mono: Output a single audio channel.
   :Stereo: Output two audio channels; typically a left and right channel.
   :4 Channels: Output a four audio channels.
   :5.1 Surround:  Output a five audio channels with one :abbr:`LFE (low-frequency effects)` channel.
   :7.1 Surround: Output a seven audio channels with one :abbr:`LFE (low-frequency effects)` channel.

.. _bpy.types.PreferencesSystem.audio_mixing_buffer:

Mixing Buffer
   Sets the number of samples used by the audio mixing buffer.
   Higher buffer sizes can cause latency issues,
   but if you hear clicks or other problems, try to increase the size.

.. _bpy.types.PreferencesSystem.audio_sample_rate:

Sample Rate
   Sets the audio `sampling rate <https://en.wikipedia.org/wiki/Sampling_(signal_processing)#Sampling_rate>`__.

.. _bpy.types.PreferencesSystem.audio_sample_format:

Sample Format
   Sets the audio sample format.