OutputFile


Synopsis

Output an AVS/Express .x file by capturing the contents of the view

Note: This object has superceded a previous version of an object with the same name. Please note that the older version's template is VIEW.Viewers.OutputFile, and this version's template is GDM.Viewers.OutputFile. The render_view input port present in the old template is no longer necessary when used with the new Uviewers.

V name

GDM.OutputFile

Input Ports

view_in

GDview_templ

Description

The OutputFile macro defines file output. It contains a user interface that appears in the Module Panel provided by the DataViewer or ModuleStack (as appropriate).

Three different types of output are available from the AVS/Express viewers: file output, field output, and print output. They are derived from a single base group that provides the basic hooks into the rendering pipeline to get output from the view.

OutputFile captures the contents of the view as an AVS/Express image and writes it to a file. This could have been done as a post-process on the field output but a separate module eliminates the need to have an extra copy of the data in memory. This is significant if the size of the view being captured is large (for example, 4K by 4K).

Input Ports

view_in

A view. The contents of the input view are captured and written to the specified file.

Parameters

filename

This parameter specifies the name of the output file that is created.

width
height

These parameters control the width and height in pixels at which the view is captured.

flip

This parameter controls whether the contents of the view are inverted before being written to the output file.

dynamic

This parameter controls whether a file is output each time the view is rendered: 0 means no; 1 means yes.

output

This parameter when set causes a file to be output. This is used when the dynamic parameter is set to a value of 0.

Example

Not available.

File

v/gd.v , v/view.v

See also

OutputVPS