File: previews.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 (118 lines) | stat: -rw-r--r-- 4,471 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

********************
Blend-Files Previews
********************

A blend-file can store previews, both for itself, and for some of its :doc:`data-blocks </files/data_blocks>`.
You can disable writing any previews when saving a blend-file using the *Save Preview Images* setting
from the :ref:`prefs-save-load` section of the Preferences.


Blend-File Preview
==================

Blender saves by default a small preview of current scene in the blend-file.
This will show in the *Thumbnail* view of the :doc:`File Browser </editors/file_browser>`.

During its installation, Blender also adds a small tool to your OS,
that will allow your system file browser to show those previews as file thumbnails as well.


Data-Blocks Previews
====================

Blender will automatically generate previews for some type of data, mainly the ones related to shading
(like images, textures, materials, lights and world shaders).

It can also store previews for scenes, collections and objects, but those need to be generated manually.

These previews can then be used by the *Thumbnail* view of the File Browser, when linking or appending data-blocks.


.. _bpy.ops.wm.previews_ensure:

Refresh Data-Block Previews
---------------------------

.. reference::

   :Menu:      :menuselection:`File --> Data Previews --> Refresh Data-blocks Previews`

Refresh all data-block previews that can be automatically generated by Blender (shading-related ones),
in the current blend-file. You still need to save the file if you want to write them to the drive.


.. _bpy.ops.wm.previews_batch_generate:

Batch Generate Previews
-----------------------

.. reference::

   :Menu:      :menuselection:`File --> Data Previews --> Batch Generate Previews`

Generate some data-block types' previews (you can choose which in its options),
in one or more blend-files on your drive. You should not use this operator on the file currently opened in Blender.

This is currently the only way to generate and store in blend-files previews for scenes, collections and objects.
Note that since this involves a lot of rendering, even of small sizes, the process may take some time to complete.

Scenes
   Generate previews of scenes and their collections.
Collections
   Generate previews of collections of objects.
Objects
   Generate previews of objects.
Materials & Textures
   Generates previews for materials, textures, images, and other internal data.
Trusted Blend Files
   When enabled, Python scripts and drivers that may be included in the file will be run automatically.
   Enable this only if you created the file yourself,
   or you trust that the person who gave it to you did not include any malicious code with it.
   See :doc:`Python Security </advanced/scripting/security>` to configure default trust options.
Save Backups
   Keep a :ref:`backup version <bpy.types.PreferencesFilePaths.save_version>` (``blend1-file``)
   of the files when saving with generated previews.


.. _bpy.ops.wm.previews_clear:

Clear Data-Block Previews
-------------------------

.. reference::

   :Menu:      :menuselection:`File --> Data Previews --> Clear Data-blocks Previews`

Clear all, a generic type of, or a specific data-block type of previews in the current blend-file.
You still need to save the file if you want to clear them from the drive.


.. _bpy.ops.wm.previews_batch_clear:

Batch Clear Previews
--------------------

.. reference::

   :Menu:      :menuselection:`File --> Data Previews --> Batch Clear Previews`

Clear some data-block types' previews (you can choose which in its options),
in one or more blend-files on your drive. You should not use this operator on the file currently opened in Blender.

Scenes
   Clear previews of scenes and their collections.
Collections
   Clear previews of collections of objects.
Objects
   Clear previews of objects.
Materials & Textures
   Clear previews for materials, textures, images, and other internal data.
Trusted Blend Files
   When enabled, Python scripts and drivers that may be included in the file will be run automatically.
   Enable this only if you created the file yourself,
   or you trust that the person who gave it to you did not include any malicious code with it.
   See :doc:`Python Security </advanced/scripting/security>` to configure default trust options.
Save Backups
   Keep a :ref:`backup version <bpy.types.PreferencesFilePaths.save_version>` (``blend1-file``)
   of the files when saving with cleared previews.