Difference between revisions of "Documentation:Windows Section 4"

From POV-Wiki
Jump to navigation Jump to search
m (tag repair 1 place)
Line 16: Line 16:
 
<!--<indexentry primary "Main Window">--->
 
<!--<indexentry primary "Main Window">--->
  
<p>[[Image:WinImgWindows.gif|A screenshot taken during a render]]</p>
+
<p>[[Image:MainWindowSmall.png|POV-Ray for Windows Main Window]]</p>
  
 
===The Toolbar===
 
===The Toolbar===
Line 89: Line 89:
 
Displayed within the main window is a tabbed control. Using this you may select either the
 
Displayed within the main window is a tabbed control. Using this you may select either the
 
Message window or an Editor window (if a file is open) to be displayed within the main window.
 
Message window or an Editor window (if a file is open) to be displayed within the main window.
In the above example image, an edit window has been selected, and part of the message window
+
You may also switch tabs by using the 'Alt+Left Arrow', 'Alt+Right Arrow', 'Ctrl+Tab' or 'Shift+Ctrl+Tab'
is showing at the bottom (since the screenshot was taken during a render). You may also switch
 
tabs by using the 'Alt+Left Arrow', 'Alt+Right Arrow', 'Ctrl+Tab' or 'Shift+Ctrl+Tab'
 
 
keyboard shortcuts.
 
keyboard shortcuts.
 +
</p>
 +
 +
</p>
 +
Hovering your mouse over an editor tab will cause the name of the file to be shown in a hint.
 +
Right-clicking on it will pop up a menu providing the option to copy the full filename to the
 +
clipboard or to open the folder containing the file in Windows Explorer. Middle-clicking on it will close the tab.
 
</p>
 
</p>
  
Line 104: Line 108:
 
===The Message Window===
 
===The Message Window===
 
<!--<indexentry primary "Message Window">--->
 
<!--<indexentry primary "Message Window">--->
 
<p>[[Image:WinImgMessagewin.gif|-]]</p>
 
  
 
<p>
 
<p>
Line 153: Line 155:
 
</p>
 
</p>
  
<p>Due to issues with CPU usage, the new render window is now <em>off</em> by default. To work well this feature requires that hardware-assisted alpha blending is available on the target system, and as of the time of writing this is not common enough to justify turning it on by default.</p>
 
<p class="Note"><strong>Note:</strong> It will remain turned on if you already had it on (e.g. from a previous version).</p>
 
<p>The new render window mode is only available on Windows 2000 or later.</p>
 
 
<p class="Warning"><strong>Warning:</strong> Just because you can see the image in the Render Window does not mean it is being saved to disk, or that it can be saved to disk. In many cases the data stored for display purposes is different than the data stored in an output file. If you don't have <!--<linkto "Output_To_File">Output_To_File</linkto>--->[[Documentation:Reference Section 1.1#File Output Options|Output_To_File]] switched ON (this is the default, unless you have turned it off) then you will not get an output file and once the render is finished it is too late. If you want an output file you must select it before you start rendering.
 
<p class="Warning"><strong>Warning:</strong> Just because you can see the image in the Render Window does not mean it is being saved to disk, or that it can be saved to disk. In many cases the data stored for display purposes is different than the data stored in an output file. If you don't have <!--<linkto "Output_To_File">Output_To_File</linkto>--->[[Documentation:Reference Section 1.1#File Output Options|Output_To_File]] switched ON (this is the default, unless you have turned it off) then you will not get an output file and once the render is finished it is too late. If you want an output file you must select it before you start rendering.
 
</p>
 
</p>
  
 
<p>
 
<p>
We realise that this is different from many Windows programs, but the resources needed to store a full version of a rendered image in memory (especially if it's large) could often be best used elsewhere. The Render Window is only meant to be a <strong><em>preview</em></strong> of the final image. It is there for convenience.
+
We realize that this is different from many Windows programs, but the resources needed to store a full version of a rendered image in memory (especially if it's large) could often be best used elsewhere. The Render Window is only meant to be a <strong><em>preview</em></strong> of the final image. It is there for convenience.
 
</p>
 
</p>
  
Line 177: Line 176:
 
If you have a high or true color display, selecting the 'Options|Render Window|Force 8-bit Display' option will cause only one-third of the memory to be allocated for the render bitmap, since the data will be stored (and displayed) as 8-bit pixels instead of true-color (24-bit). Needless to say, this has absolutely no effect on the output file.
 
If you have a high or true color display, selecting the 'Options|Render Window|Force 8-bit Display' option will cause only one-third of the memory to be allocated for the render bitmap, since the data will be stored (and displayed) as 8-bit pixels instead of true-color (24-bit). Needless to say, this has absolutely no effect on the output file.
 
</p>
 
</p>
 
<p class="Note"><strong>Note:</strong> We have not tested this new code on a Windows 2000 system, so we can't comment on how well it will work on those systems.</p>
 
<p>To activate the new render window, open the 'Render Window' sub-menu in the 'Options' menu, and select the 'Use New-style Render Window' entry.</p>
 
<p>The new render window is designed to help users get around the issue of the render window getting in the way when doing edit/render/fix cycles. It supports a 'transparency' mode that is in effect two things: both optical translucency, and input transparency.</p>
 
<p>'Input transparency' means that the window is transparent to input - so if you move your mouse over it or attempt to click on it, the mouse messages are in fact sent to whatever is underneath the window. In effect it is as if the window were not there - even if you can still see it. The benefit of this is that, coupled with translucency, you can both see what is under the window (e.g. the POV-Ray editor), and also work with it (typing or selecting with the mouse, etc).</p>
 
<p>'Input Transparency' is enabled whenever you set the translucency of the render window to 25% or more (see below). At settings less than this, the render window will behave more or less as normal (though without some of the features of the classic render window, such as the ability to be de-coupled from the main window such that it does not get hidden when the main window is minimized).</p>
 
<p>To set the translucency of the render window, either rotate your mouse wheel when the render window has focus (this is the preferred method), or alternatively right-click on the window's title bar and choose a setting from the context menu that is provided.</p>
 
<p>When the render window has input focus, translucency is removed and it becomes opaque. It will switch back once another window gets focus, or if you adjust the translucency using one of the above methods.</p>
 
<p>If you want to work with input transparency, it is important that you understand that this means you can't work with the render window in the manner you are accustomed to, since of course the window will pass input to the application below it. To allow for interaction with the window in this circumstance, we have added a feature whereby hovering the mouse over the render window's caption for a short time, or clicking on the title bar, will activate the window, make it opaque, and allow input to be processed normally. Of course the ability to click on the caption means that it's not completely input transparent, and we might disable this feature later if the hover feature works out well.</p>
 
<p>You will know that your mouse is over the appropriate area of the window, because the cursor will turn to a hourglass shape during the 'hover' time. When the window is left in input transparency mode, if you move your mouse out of the window for a short time, it will automatically snap back into its former translucent mode.</p>
 
<p>You can tell if the window is in input transparency mode by looking for a '[T]' at the start of the render window caption. If present, then it's going to pass input to the application underneath it. While adjusting the translucency with the mouse wheel, the caption will display the new translucency setting and, if appropriate, a comment that the window has switched to passing input.</p>
 
<p class="Note"><strong>Note:</strong> This doesn't take affect until you switch focus to another window.</p>
 
  
 
<p>
 
<p>

Revision as of 12:13, 2 January 2011

This document is protected, so submissions, corrections and discussions should be held on this documents talk page.


Windows

This section gives you a short run-down on the three main window elements that you will need to deal with - the Main Window, the Message Window, and the Render Window.

The Main Window

POV-Ray for Windows Main Window

The Toolbar

The toolbar contains a number of buttons and two controls. The buttons are labelled and should be self-explanatory. The purpose of the two controls, which are the pre-set rendering options combobox and the toolbar command-line, are discussed below.

Preset Rendering Options

-

This combobox contains a list of pre-set rendering options that you can choose just by clicking on one of them. By default, the list contains resolution and anti-aliasing related options, however, any POV-Ray option can be specified in the INI file that the list in the combobox is built from. It is easy to add your own entries to this list; see the section titled Adding New Resolutions for instructions.

Note: Options entered on the POV-Ray command-line (via the toolbar, the command-line dialog, or the pvengine.exe command-line) will override any options specified by the above combobox.

Toolbar Command Line

-

The toolbar command-line is a shortcut to the command-line that is found in the Command Line Dialog. In past versions of POV-Ray for Windows, the key combination Alt+C would bring up the command-line dialog; now it will instead shift focus to the toolbar command-line. The command-line dialog is still accessible via the Render Menu, as before.

Once the toolbar command-line has focus, you may return focus to the editor or message window by pressing ESCAPE. Pressing ENTER will start a render.

Any valid generic POV-Ray command-line switch can be used in this command-line, including INI options. See the Options Reference for a full list.

Hint: The Editor Context Menu has a handy shortcut for copying commonly-used command-lines from your scene files into the command-line field.

The Status Bar

At the bottom of the main window is a status bar. The left part of the status bar contains an information and help field. After that comes the current line and column of the editor caret, followed by a panel that shows 'INS' for editor insert mode, and 'OVR' for overwrite mode. Next to this you will find a Pixel-Per-Second indicator and a clock showing time elapsed (in days-hours-minutes-seconds) since the beginning of the last render job. This clock stops when the job completes. Note that on extremely slow renders, the PPS indicator may change to showing PPM (pixels per minute), or PPH (pixels per hour). Note also that the clock shows only elapsed time - not CPU time. As Windows is a multi-tasking operating system the two are not the same (though if you are running no other applications they will be fairly close).

The Tab Control

Displayed within the main window is a tabbed control. Using this you may select either the Message window or an Editor window (if a file is open) to be displayed within the main window. You may also switch tabs by using the 'Alt+Left Arrow', 'Alt+Right Arrow', 'Ctrl+Tab' or 'Shift+Ctrl+Tab' keyboard shortcuts.

Hovering your mouse over an editor tab will cause the name of the file to be shown in a hint. Right-clicking on it will pop up a menu providing the option to copy the full filename to the clipboard or to open the folder containing the file in Windows Explorer. Middle-clicking on it will close the tab.

Note that POV-Ray for Windows does not support MDI (the Multiple Document Interface). This is by design. You can only display one window at a time (with the exception that you can see a portion of the Message window from an editor window when rendering, and that the editor itself can split the edit pane into several views).

The Message Window

The message window displays text output from the POV-Ray raytracing engine. You'll find such things as render setting info, parse/render statistics, and parse warnings/errors displayed here. It has its own Context Menu.

You can change the background of the message window, along with its font and font color, from the Options|Message Window menu. The Edit menu allows you to copy the currently visible message pane to the clipboard as text (it is not possible to select portions of the text), and to erase the messages.

By default, each time you run a render, new messages are appended to the end of the existing messages. You can specify that the old messages be cleared before a render by turning off 'Preserve Messages' in the options menu.

The Editor Window

-

An Editor Window shows a file which has been opened for editing. It has its own Context Menu. There will be one editor window for each open file (maximum 32). The particular editor window being shown depends on the tab control that contains it.

There are an extensive set of options available for customizing the appearance and function of the editor window. See the sections on Using the Internal Editor, Configuring the Internal Editor, the Editor Menu, the Text Menu, and the Editor Preferences Dialog.

The Render Window

-

The Render Window pops up whenever you render a scene with the POV-Ray 3 display option (+d) set. The Render Window shows the scene as it is being rendered. It has its own Context Menu. If you close the Render Window you can re-display it by selecting Re-display from the Render Window submenu in the Options Menu, or by pressing the 'Show' button on the toolbar.

Warning: Just because you can see the image in the Render Window does not mean it is being saved to disk, or that it can be saved to disk. In many cases the data stored for display purposes is different than the data stored in an output file. If you don't have Output_To_File switched ON (this is the default, unless you have turned it off) then you will not get an output file and once the render is finished it is too late. If you want an output file you must select it before you start rendering.

We realize that this is different from many Windows programs, but the resources needed to store a full version of a rendered image in memory (especially if it's large) could often be best used elsewhere. The Render Window is only meant to be a preview of the final image. It is there for convenience.

Don't forget that if you choose (via an INI file) to have images written to a default directory, then that is where they will be unless you override this behavior. If you didn't select this option then the file will be written to the current directory. Specifying an output file name that consists of only a path, such as c:\images\, will cause the output file to be written to that directory. POV-Ray determines if the filename is a path by looking at the last character and making sure that it is a '\'. The directory must already exist.

Note: To disable the Render Window, you must specify the -d option on the command-line, or Display=Off on the command-line or in one of the INI files processed. Simply closing the render window after it is created does not free up the memory used by it.

If you are running a high-resolution render, and have a high-color or true-color display, you can save a considerable amount of RAM by turning the render window off. Users of 8-bit display systems can save a smaller amount. The amount of RAM used by the render window can be calculated as render width * render height bytes, in the case of 8-bit displays, or render width * render height * 3 bytes, for high/true color displays. For example, on a true color system, a render of a 1024x768 pixel image will require about 2.4 megabytes of image buffer (even if you hide or minimize the render window). The only way to avoid this is to turn the render window off before the render starts.

If you have a high or true color display, selecting the 'Options|Render Window|Force 8-bit Display' option will cause only one-third of the memory to be allocated for the render bitmap, since the data will be stored (and displayed) as 8-bit pixels instead of true-color (24-bit). Needless to say, this has absolutely no effect on the output file.

See also Speed Considerations.


Command-Line Options Menus


This document is protected, so submissions, corrections and discussions should be held on this documents talk page.