[Bf-docboard-svn] bf-manual: [8472] trunk/blender_docs/manual: Cleanup: Image properties
Aaron Carlisle
noreply at blender.org
Sat Oct 9 04:40:02 CEST 2021
Revision: 8472
https://developer.blender.org/rBM8472
Author: Blendify
Date: 2021-10-09 04:40:02 +0200 (Sat, 09 Oct 2021)
Log Message:
-----------
Cleanup: Image properties
- Add rna links
- Order properties according to the UI
- General cleanup and fixes
Modified Paths:
--------------
trunk/blender_docs/manual/editors/image/image_settings.rst
trunk/blender_docs/manual/render/cameras.rst
trunk/blender_docs/manual/video_editing/preview/sidebar.rst
Modified: trunk/blender_docs/manual/editors/image/image_settings.rst
===================================================================
--- trunk/blender_docs/manual/editors/image/image_settings.rst 2021-10-09 02:01:32 UTC (rev 8471)
+++ trunk/blender_docs/manual/editors/image/image_settings.rst 2021-10-09 02:40:02 UTC (rev 8472)
@@ -19,6 +19,8 @@
The *New Image* button opens a pop-up to configure a `Generated`_ image.
+.. _bpy.types.Image.source:
+
Source
------
@@ -36,40 +38,36 @@
Image Sequence
^^^^^^^^^^^^^^
-Each frame is stored in a separate file.
-How to :ref:`image-formats-open-sequence`.
+Each frame is stored in a separate file. How to :ref:`image-formats-open-sequence`.
+For options see `Movie`_ below.
-Frame
- A label showing the current frame.
-Further options
- See `Movie`_ below.
-
Movie
^^^^^
Frames packed into a container.
+Frames
+ Sets the range of frames to use.
+
+ Match Movie Length
+ This button sets the movies *frames* to the length of the selected movie.
+
+Start
+ Global starting frame of the sequence, when the playback should start.
+ This is a global setting which means it affects all clip users such as the Movie Clip editor itself,
+ motion tracking constraints and Compositor nodes.
+Offset
+ Offsets the first frame of the clip. It adds an extra offset to the frame number when
+ converting a scene frame to the frame number in the file name.
+ This option does not affect tracking data or any other associated data.
+Cyclic
+ Start over and repeats after the last frame to create a continuous loop.
+Auto Refresh
+ Automatically refresh images on frame changes.
Deinterlace
Removes fields in a video file. For example,
if it is an analog video and it has even or odd interlacing fields.
-Frame
- Frames
- Sets the range of frames to use.
- Start
- Global starting frame of the sequence, when the playback should start.
- This is a global setting which means it affects all clip users such as the Movie Clip editor itself,
- motion tracking constraints and Compositor nodes.
- Offset
- Offsets the first frame of the clip. It adds an extra offset to the frame number when
- converting a scene frame to the frame number in the file name.
- This option does not affect tracking data or any other associated data.
-Match Movie Length
- This button sets the movies *frames* to the length of the selected movie.
-Auto Refresh
- Automatically refresh images on frame changes.
-Cyclic
- Start over and repeats after the last frame to create a continuous loop.
.. _image-generated:
@@ -94,11 +92,9 @@
Color
Sets the fill color if creating a blank image.
Type
- Blank
- Creates a Blank image of a single specified color.
- UV Grid
- Creates a checkerboard pattern with a colored cross (+) in each square.
- Color Grid
+ :Blank: Creates a Blank image of a single specified color.
+ :UV Grid: Creates a checkerboard pattern with a colored cross (+) in each square.
+ :Color Grid:
Creates a more complex colored grid with letters and numbers denoting locations in the grid.
It could be used for testing how the UVs have been mapped and to reduce stretching or distortion.
32-bit Float
@@ -111,11 +107,12 @@
.. _editors-image-image-settings-common:
-.. _bpy.types.Image.use_half_precision:
Common Options
--------------
+.. _bpy.types.Image.filepath:
+
File
Use for replacing or packing files.
@@ -127,43 +124,51 @@
Opens the :doc:`/editors/file_browser` to select a file from a drive.
Reload
Reloads the file. Useful when a file has been reworked in an external application.
+
+.. _bpy.types.Image.is_multiview:
+
+Use Multi-View
+ See :doc:`Multi-View </render/output/properties/stereoscopy/index>`.
+
+.. _bpy.types.ColorManagedInputColorspaceSettings.name:
+
Color Space
:term:`Color Space`.
- sRGB
- Standard RGB display space.
- Linear
- Linear 709 (full range). Blender native linear space.
- Linear ACES
- ACES linear space.
- XYZ
- Standard linear XYZ space.
- Non-Color
- Color space used for images which contains non-color data (e.g. normal maps).
- Raw
- Same as Non-Color.
- Filmic Log
- Intermediate log color space of Filmic view transform.
-Half Float Precision
- Load the image as having only a :term:`Bit Depth` of 16 bits per channel instead of 32 bits which saves memory.
-View as Render
- Applies :doc:`color transform </render/color_management>` when displaying this image on the screen.
-Use Multi-View
- See :doc:`Multi-View </render/output/properties/stereoscopy/index>`.
+ :sRGB: Standard RGB display space.
+ :Linear: Linear 709 (full range). Blender native linear space.
+ :Linear ACES: ACES linear space.
+ :XYZ: Standard linear XYZ space.
+ :Non-Color: Color space used for images which contains non-color data (e.g. normal maps).
+ :Raw: Same as Non-Color.
+ :Filmic Log: Intermediate log color space of Filmic view transform.
+
+.. _bpy.types.Image.alpha_mode:
+
Alpha
- Representation of alpha in the image file, to convert to and from when saving and loading the image.
- See :term:`Alpha Channel`.
+ Representation of the image's :term:`Alpha Channel`, to convert to and from when saving and loading the image.
+ This option is only available if the input format support's encoding transparency.
- Straight
+ :Straight:
Store RGB and alpha channels separately with alpha acting as a mask, also known as unassociated alpha.
Commonly used by image editing applications and file formats like PNG.
This preserves colors in parts of the image with zero alpha.
- Premultiplied
+ :Premultiplied:
Store RGB channels with alpha multiplied in, also known as associated alpha.
The natural format for renders and used by file formats like OpenEXR.
This can represent purely emissive effects like fire correctly, unlike straight alpha.
- Channel Packed
+ :Channel Packed:
Different images are packed in the RGB and alpha channels, and they should not affect each other.
Channel packing is commonly used by game engines to save memory.
- None
+ :None:
Ignore alpha channel from the file and make image fully opaque.
+
+.. _bpy.types.Image.use_half_precision:
+
+Half Float Precision
+ Load the image as having only a :term:`Bit Depth` of 16 bits per channel instead of 32 bits which saves memory.
+
+.. _bpy.types.Image.use_view_as_render:
+
+View as Render
+ Applies :doc:`color transform </render/color_management>` when displaying this image on the screen.
Modified: trunk/blender_docs/manual/render/cameras.rst
===================================================================
--- trunk/blender_docs/manual/render/cameras.rst 2021-10-09 02:01:32 UTC (rev 8471)
+++ trunk/blender_docs/manual/render/cameras.rst 2021-10-09 02:40:02 UTC (rev 8472)
@@ -1,6 +1,5 @@
.. _bpy.types.Camera:
.. _bpy.ops.camera:
-.. _cameras-index:
*******
Cameras
@@ -193,8 +192,6 @@
and a higher number will cause a vertical distortion.
-.. _bpy.types.Camera.sensor:
-
Camera
------
@@ -201,6 +198,8 @@
These settings adjusts properties that relate to a physical camera body.
Several :ref:`Presets <ui-presets>` can be chosen to match real world cameras.
+.. _bpy.types.Camera.sensor_fit:
+
Sensor Fit
Adjusts how the camera's sensor fits within the outputs dimension adjusting the angular field of view.
@@ -214,17 +213,17 @@
Manually adjust the *Height* of the sensor, the *Width* is calculated based on
the aspect ratio of the output's :ref:`Resolution <bpy.types.RenderSettings.resolution_y>`.
-.. _render-camera-sensor-size:
+.. _bpy.types.Camera.sensor_height:
+.. _bpy.types.Camera.sensor_width:
-Sensor Size
+Size / Width, Height
This setting is an alternative way to control the field of view, as opposed to modifying the focal length.
It is useful to match a camera in Blender to a physical camera and lens combination,
e.g. for :doc:`motion tracking </movie_clip/index>`.
+.. _bpy.ops.safe_areas:
.. _bpy.types.DisplaySafeAreas:
-.. _bpy.ops.safe_areas:
-.. _camera-safe-areas:
Safe Areas
----------
@@ -301,15 +300,13 @@
Background Source
The source of the background image.
- Image
+ :Image:
Use an external image, image sequence, video file or generated texture.
- Movie Clip
+ :Movie Clip:
Use one of the Movie Clip data-blocks.
Active Clip
Follow the scene's :ref:`active clip <scene-active-clip>`.
- Color Space
- The color space the image or video file uses within Blender.
Render Undistorted
Draw the background image using undistorted proxies when available.
Proxy Render Size
@@ -320,30 +317,37 @@
To build a proxy, the :ref:`Movie Clip Editor Proxy settings <bpy.types.MovieClipProxy>` have to be used.
Otherwise the proxy settings here have no effect.
+Color Space
+ The color space the image or video file uses within Blender.
+
Opacity
Controls the transparency of the background image.
+
Depth
Choose whether the image is shown behind all objects, or in front of everything.
+
Frame Method
Controls how the image is placed in the camera view.
- Stretch
- Forces the image dimensions to match the camera bounds (may alter the aspect ratio).
- Fit
- Scales the image down to fit inside the camera view without altering the aspect ratio.
- Crop
+ :Stretch: Forces the image dimensions to match the camera bounds (may alter the aspect ratio).
+ :Fit: Scales the image down to fit inside the camera view without altering the aspect ratio.
+ :Crop:
Scales the image up so that it fills the entire camera view,
but without altering the aspect ratio (some of the image will be cropped).
-Offset X/Y
+
+Offset X, Y
Positions the background image using these offsets.
In orthographic views, this is measured in the normal scene units.
In the camera view, this is measured relative to the camera bounds
(0.1 will offset it by 10% of the view width/height).
+
Rotation
Rotates the image around its center.
+
Scale
Scales the image up or down from its center.
+
Flip
X
Swaps the image around, such that the left side is now on the right, and the right now on the left.
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-docboard-svn
mailing list