[Bf-docboard-svn] bf-manual: [9078] trunk/blender_docs/manual: Video Editing: Move preview sidebar to editor documentation

Aaron Carlisle noreply at blender.org
Thu Mar 3 21:14:54 CET 2022


Revision: 9078
          https://developer.blender.org/rBM9078
Author:   Blendify
Date:     2022-03-03 21:14:54 +0100 (Thu, 03 Mar 2022)
Log Message:
-----------
Video Editing: Move preview sidebar to editor documentation

Modified Paths:
--------------
    trunk/blender_docs/manual/editors/video_sequencer/preview/index.rst
    trunk/blender_docs/manual/video_editing/preview/index.rst

Added Paths:
-----------
    trunk/blender_docs/manual/editors/video_sequencer/preview/sidebar.rst

Removed Paths:
-------------
    trunk/blender_docs/manual/video_editing/preview/sidebar.rst

Modified: trunk/blender_docs/manual/editors/video_sequencer/preview/index.rst
===================================================================
--- trunk/blender_docs/manual/editors/video_sequencer/preview/index.rst	2022-03-03 20:08:17 UTC (rev 9077)
+++ trunk/blender_docs/manual/editors/video_sequencer/preview/index.rst	2022-03-03 20:14:54 UTC (rev 9078)
@@ -9,3 +9,4 @@
    introduction.rst
    controls/index.rst
    display/index.rst
+   sidebar.rst

Copied: trunk/blender_docs/manual/editors/video_sequencer/preview/sidebar.rst (from rev 9077, trunk/blender_docs/manual/video_editing/preview/sidebar.rst)
===================================================================
--- trunk/blender_docs/manual/editors/video_sequencer/preview/sidebar.rst	                        (rev 0)
+++ trunk/blender_docs/manual/editors/video_sequencer/preview/sidebar.rst	2022-03-03 20:14:54 UTC (rev 9078)
@@ -0,0 +1,163 @@
+
+*******
+Sidebar
+*******
+
+Tool
+====
+
+Displays information about the active tool.
+
+
+View
+====
+
+View Settings
+-------------
+
+.. _bpy.types.SpaceSequenceEditor.proxy_render_size:
+
+Proxy Render Size
+   Size to display proxies at in the preview region.
+   Using a smaller preview size will increase speed.
+
+   :No Display: Disables the preview.
+   :Scene Size: Matches proxy size to the final render :ref:`resolution <bpy.types.RenderSettings.resolution_y>`.
+   :25%, 50%, 75%, 100%: Proxies are sized to be the selected percent of the original input.
+
+.. _bpy.types.SpaceSequenceEditor.use_proxies:
+
+Use Proxies
+   Use optimized files for faster scrubbing when available.
+   Proxies limit the visual accuracy of the preview by reducing
+   the preview resolution and using compressed copies of the input.
+
+.. _bpy.types.SequenceEditor.use_prefetch:
+
+Prefetch Frames
+   Automatically fill the cache with frames after the current frame in the background.
+   Use this to achieve a more consistent playback speed.
+   This feature currently doesn't support rendering Scene strips.
+
+.. _bpy.types.SpaceSequenceEditor.display_channel:
+
+Channel
+   Selects the channel to show in the preview.
+
+   Channel 0 is the compositing result of all strips.
+   Channel 1 is the current frame's image from the strip in channel 1 only
+   (channel 1 is at the bottom of the stack). The display of these modes is either the composite
+   (channel 0) or the frame from the strip (channels 1 through n).
+
+.. _bpy.types.SpaceSequenceEditor.show_overexposed:
+
+Show Overexposed
+   Shows overexposed (bright white) areas using a zebra pattern.
+   The threshold can be adjust with the slider.
+
+
+.. _editors_sequencer_preview_2d-cursor:
+
+2D Cursor
+---------
+
+The 2D cursor is the white-red circle with a cross-hair that is shown in the main region.
+It can be used by setting the :ref:`Pivot Point <bpy.types.SequencerToolSettings.pivot_point>`
+to *2D Cursor* to transform all strips in relation to the location of the 2D cursor.
+
+The visibility of the 2D cursor can be controlled with the
+:ref:`2D Cursor <bpy.types.SequencerPreviewOverlay.show_cursor>` overlay option.
+
+.. _bpy.types.SpaceSequenceEditor.cursor_location:
+
+Location X, Y
+   The location of the 2D cursor relative to the center of the main region.
+   The edge of the image will be 0.5 away, so (0.5, 0.5) will be the top right corner.
+
+   The 2D cursor's location can also be set with Cursor tool or by :kbd:`Shift-RMB`.
+
+
+.. _bpy.types.SequenceEditor.show_overlay:
+
+Frame Overlay
+-------------
+
+Option to enable the overlay.
+It can be used for comparing the current frame to a reference frame.
+
+.. _bpy.ops.sequencer.view_ghost_border:
+
+Set Overlay Region
+   Selects the rectangular bounds for the overlay region.
+   This area can be defined by pressing :kbd:`O` key over the preview.
+
+.. _bpy.types.SequenceEditor.overlay_frame:
+
+Frame Offset
+   The slider controls the offset of the reference frame relative to current frame.
+
+.. _bpy.types.SpaceSequenceEditor.overlay_frame_type:
+
+Overlay Type
+   It describes the way the reference frame should be displayed.
+
+   :Rectangle: Which means the rectangle area of reference frame will be displayed on top of current frame.
+   :Reference: Only the reference frame is displayed in the preview region.
+   :Current: Only the current frame is displayed in the preview region.
+
+   .. tip::
+
+      It is possible to have several Sequence Editors opened and they can use different overlay types.
+      So it is possible to have current and reference frames displayed in different editor spaces.
+
+.. _bpy.types.SequenceEditor.use_overlay_frame_lock:
+
+Overlay Lock
+   It's still possible to lock the reference frame to its current position.
+
+
+Safe Areas
+----------
+
+Shows guides used to position elements to ensure that
+the most important parts of the video can be seen across all screens.
+
+.. seealso::
+
+   See :ref:`Safe Areas <bpy.types.DisplaySafeAreas>` in the camera docs.
+
+
+Scene Strip Display
+-------------------
+
+It allows you to control how the images of :doc:`Scene Strips </video_editing/sequencer/strips/scene>`
+are displayed in the preview.
+
+.. _bpy.types.RenderSettings.sequencer_gl_preview:
+
+Shading
+   Method for rendering the viewport.
+   See the 3D Viewport's :ref:`view3d-viewport-shading` options.
+
+.. _bpy.types.RenderSettings.use_sequencer_override_scene_strip:
+
+Override Scene Settings
+   Use the Workbench render settings from the sequencer scene,
+   instead of each individual scene used in the strip.
+
+
+Annotations
+-----------
+
+Allows you to use :doc:`Annotations </interface/annotate_tool>` in the Sequencer.
+
+
+Metadata
+========
+
+A list of metadata of the displayed image.
+
+.. note::
+
+   The metadata will only be displayed for the image, that has not been processed by any effect.
+   By default images are processed by alpha over blending.

Modified: trunk/blender_docs/manual/video_editing/preview/index.rst
===================================================================
--- trunk/blender_docs/manual/video_editing/preview/index.rst	2022-03-03 20:08:17 UTC (rev 9077)
+++ trunk/blender_docs/manual/video_editing/preview/index.rst	2022-03-03 20:14:54 UTC (rev 9078)
@@ -8,4 +8,3 @@
 
    introduction.rst
    toolbar/index.rst
-   sidebar.rst

Deleted: trunk/blender_docs/manual/video_editing/preview/sidebar.rst
===================================================================
--- trunk/blender_docs/manual/video_editing/preview/sidebar.rst	2022-03-03 20:08:17 UTC (rev 9077)
+++ trunk/blender_docs/manual/video_editing/preview/sidebar.rst	2022-03-03 20:14:54 UTC (rev 9078)
@@ -1,163 +0,0 @@
-
-*******
-Sidebar
-*******
-
-Tool
-====
-
-Displays information about the active tool.
-
-
-View
-====
-
-View Settings
--------------
-
-.. _bpy.types.SpaceSequenceEditor.proxy_render_size:
-
-Proxy Render Size
-   Size to display proxies at in the preview region.
-   Using a smaller preview size will increase speed.
-
-   :No Display: Disables the preview.
-   :Scene Size: Matches proxy size to the final render :ref:`resolution <bpy.types.RenderSettings.resolution_y>`.
-   :25%, 50%, 75%, 100%: Proxies are sized to be the selected percent of the original input.
-
-.. _bpy.types.SpaceSequenceEditor.use_proxies:
-
-Use Proxies
-   Use optimized files for faster scrubbing when available.
-   Proxies limit the visual accuracy of the preview by reducing
-   the preview resolution and using compressed copies of the input.
-
-.. _bpy.types.SequenceEditor.use_prefetch:
-
-Prefetch Frames
-   Automatically fill the cache with frames after the current frame in the background.
-   Use this to achieve a more consistent playback speed.
-   This feature currently doesn't support rendering Scene strips.
-
-.. _bpy.types.SpaceSequenceEditor.display_channel:
-
-Channel
-   Selects the channel to show in the preview.
-
-   Channel 0 is the compositing result of all strips.
-   Channel 1 is the current frame's image from the strip in channel 1 only
-   (channel 1 is at the bottom of the stack). The display of these modes is either the composite
-   (channel 0) or the frame from the strip (channels 1 through n).
-
-.. _bpy.types.SpaceSequenceEditor.show_overexposed:
-
-Show Overexposed
-   Shows overexposed (bright white) areas using a zebra pattern.
-   The threshold can be adjust with the slider.
-
-
-.. _editors_sequencer_preview_2d-cursor:
-
-2D Cursor
----------
-
-The 2D cursor is the white-red circle with a cross-hair that is shown in the main region.
-It can be used by setting the :ref:`Pivot Point <bpy.types.SequencerToolSettings.pivot_point>`
-to *2D Cursor* to transform all strips in relation to the location of the 2D cursor.
-
-The visibility of the 2D cursor can be controlled with the
-:ref:`2D Cursor <bpy.types.SequencerPreviewOverlay.show_cursor>` overlay option.
-
-.. _bpy.types.SpaceSequenceEditor.cursor_location:
-
-Location X, Y
-   The location of the 2D cursor relative to the center of the main region.
-   The edge of the image will be 0.5 away, so (0.5, 0.5) will be the top right corner.
-
-   The 2D cursor's location can also be set with Cursor tool or by :kbd:`Shift-RMB`.
-
-
-.. _bpy.types.SequenceEditor.show_overlay:
-
-Frame Overlay
--------------
-
-Option to enable the overlay.
-It can be used for comparing the current frame to a reference frame.
-
-.. _bpy.ops.sequencer.view_ghost_border:
-
-Set Overlay Region
-   Selects the rectangular bounds for the overlay region.
-   This area can be defined by pressing :kbd:`O` key over the preview.
-
-.. _bpy.types.SequenceEditor.overlay_frame:
-
-Frame Offset
-   The slider controls the offset of the reference frame relative to current frame.
-
-.. _bpy.types.SpaceSequenceEditor.overlay_frame_type:
-
-Overlay Type
-   It describes the way the reference frame should be displayed.
-
-   :Rectangle: Which means the rectangle area of reference frame will be displayed on top of current frame.
-   :Reference: Only the reference frame is displayed in the preview region.
-   :Current: Only the current frame is displayed in the preview region.
-
-   .. tip::
-
-      It is possible to have several Sequence Editors opened and they can use different overlay types.
-      So it is possible to have current and reference frames displayed in different editor spaces.
-
-.. _bpy.types.SequenceEditor.use_overlay_frame_lock:
-
-Overlay Lock
-   It's still possible to lock the reference frame to its current position.
-
-
-Safe Areas
-----------
-

@@ Diff output truncated at 10240 characters. @@


More information about the Bf-docboard-svn mailing list