Differential D7627 Diff 24490 manual/compositing/properties.rst

Changeset View

Standalone View

manual/compositing/properties.rst


	**********			**********
	Properties			Properties
	**********			**********

	Header			The Sidebar can be shown by pressing the hotkey :kbd:`N` or by using the menu :menuselection:`View --> Sidebar'.
	======			It is located at the right hand side of the Compositor window. There are at least four tabs: Item, Tool, View, and Options.
				Sometimes, there are additional tabs from installed addons; e.g. the Node Wrangler tab (see figure below).

	.. figure:: /images/compositing_properties_header.png			Item
				====

	Compositing specific options.			.. admonition:: Reference
				:class: refbox

	Use Nodes			:Panel: :menuselection:`Sidebar region --> Item`
	Enables basic compositing set up with a :doc:`Render Layer Node </compositing/types/input/render_layers>`
	and a :doc:`Composite Node </compositing/types/output/composite>`.
	Backdrop
	Enables the use of a backdrop using a :doc:`Viewer Node </compositing/types/output/viewer>`.

	Backdrop Channels			.. figure:: /images/compositing_properties_backdrop.png
	See below.			:align: right

				Sidebar with the Render Layers node and Item tab selected.

	Backdrop			[here about figure 1: Sidebar with the Render Layers node and Item tab selected.]
	========
				Node
				Sets the name, label and color of the node. The label is shown in the title bar of the node.
				Color sets the background color of the node. It's good practice to label and color group nodes.
				All changes can be reset to the default values with the Reset Node button.
				Properties
				The properties that are shown depend on the type of node selected, e.g. a Mix node has different
				properties than a Mask node.


				Tool
				====

	.. admonition:: Reference			.. admonition:: Reference
	:class: refbox			:class: refbox

	:Panel: :menuselection:`Sidebar region --> View --> Backdrop`			:Panel: :menuselection:`Sidebar region --> Tool`

	.. figure:: /images/compositing_properties_backdrop.png			.. figure:: /images/compositing_properties_backdrop.png
	:align: right			:align: right

	Backdrop options.			Sidebar with the Tool tab selected.

				[here about figure 2: Sidebar with the Tool tab selected.]
				Active Tool
				The exact info in this panel changes with the selected tool in the Toolbar (located on the left side of the editor area).


				View
				====

				.. admonition:: Reference
				:class: refbox

				:Panel: :menuselection:`Sidebar region --> View`

				.. figure:: /images/compositing_properties_backdrop.png
				:align: right

				Sidebar with the Tool tab selected.

				[here about figure 3: Sidebar with the View tab selected.]

				Backdrop
				The backdrop is a preview of the output of a node, For example,
				:kbd:`Ctrl-Alt-LMB` on an Image node, will show the preview of the image.
				:kbd:`Ctrl-Alt-LMB` on a Mix node, will show the result of the mixing.
				You can toggle the backdrop by clicking on the Backdrop Button in the Header
				or by clicking the checkbox next to Backdrop in the View panel.

	Backdrop Channels			Backdrop Channels
	Set the image to be displayed with Color, Color and Alpha, or just Alpha.			Set the backdrop image to be displayed with Color, Color and Alpha, or just Alpha.
				You can also select the Color Channels Red, Green or Blue.
				The most accurate preview comes from Color and Alpha.
				With Color only the transparency of the image is removed and replaced with a black color.
				If you select Alpha, the transparent area is shown in black and the pixels with color info
				are displayed in white.
				Selecting the Red, Green or Blue channel will show a gray scale image. The more color
				available of the one that is selected, the whiter the preview will be. For example -
				if the Red channel is selected- a red rose against a blue sky will be shown as a white outline
				of the rose against a black sky.
	Zoom			Zoom
	Sets how big the backdrop image is.			Sets how big the backdrop image is. The value cannot be smaller than 0.01.
				The max value has no limit.
	Offset			Offset
	Change the screen space position of the backdrop,			Change the screen space position of the backdrop,
	or click the Move button, or shortcut :kbd:`Alt-MMB` to manually move it.			or click the Move button, or shortcut :kbd:`Alt-MMB` to manually move it.
	Fit			Fit
	Automatically scales the backdrop to fit the size of the editor.			Automatically scales the backdrop to fit the size of the compositor editor.
				Reset Backdrop
				Switches back to the default values of Zoom (1) and Offset (0).
				Annotations
				You can select the Annotate tool in the Toolbar (press :kbd:`T` to show the toolbar)
				to make some annotations in the Compositor window. See :doc:`Annotate Tool </interface/annotate_tool>` for more info.


	Performance			Options
	===========			=======

	.. admonition:: Reference			.. admonition:: Reference
	:class: refbox			:class: refbox

	:Panel: :menuselection:`Sidebar region --> Options --> Performance`			:Panel: :menuselection:`Sidebar region --> Options`

	.. figure:: /images/compositing_properties_performance.png			.. figure:: /images/compositing_properties_performance.png
				AlaskaUnsubmitted Not Done Inline Actions I would personally get rid of the "Can be high, medium or low" part. The user of Blender can already see these options by clicking on the drop down and the manuals writing guide says "Avoid including specific details". But you may want to wait to hear feedback from @Aaron Carlisle (Blendify) Alaska: I would personally get rid of the "Can be high, medium or low" part. The user of Blender can…
	:align: right			:align: right

	Performance settings.			Performance settings.

	This panel help you to tweak the performance of the Compositor.			This panel help you to tweak the performance of the Compositor.

	Render			Render
	Sets the quality when doing the final render.			Sets the quality when doing the final render. Can be high, medium or low.
	Edit			Edit
	Sets the quality when making edits.			Sets the quality when making edits. Can be high, medium or low.
	Chunk Size			Chunk Size
	Max size of a tile (smaller values give a better distribution of multiple threads, but more overhead).			Max size of a tile (smaller values give a better distribution of multiple threads, but more overhead).
	OpenCL			OpenCL
	This allows the use of an OpenCL platform to aid in rendering.			This allows the use of an OpenCL platform to aid in rendering.
	Generally, this should be enabled unless your hardware does not have good OpenCL support.			Generally, this should be enabled unless your hardware does not have good OpenCL support.
	Buffer Groups			Buffer Groups
	Enables buffering of group nodes to increase the speed at the cost of more memory.			Enables buffering of group nodes to increase the speed at the cost of more memory.
	Two Pass			Two Pass
	Use two pass execution during editing: the first pass calculates fast nodes, the second pass calculates all nodes.			Use two pass execution during editing: the first pass calculates fast nodes, the second pass calculates all nodes.
	Viewer Border			Viewer Border
	This allows to set an area of interest for the backdrop and preview.			This allows to set an area of interest for the backdrop.
	The region is started by :kbd:`Ctrl-B` and finished by selection of a rectangular area.			Press :kbd:`Ctrl-B` and select a rectangular area in the preview.
				This area will become your next preview in the backdrop.
	:kbd:`Ctrl-Alt-B` discards the region back to a full preview.			:kbd:`Ctrl-Alt-B` discards the region back to a full preview.
	This is only a preview option, final compositing during a render ignores this region.			This is only a preview option, final compositing during a render ignores this region.
	Auto Render			Auto Render
	Re-render and composite changed layer when edits to the 3D scene are made.			Re-render and composite changed layer when edits to the 3D scene are made.