Function RenderToFile( _
   ByVal ImageFileName As String, _
   ByVal Width As Integer, _
   ByVal Height As Integer _
) As Boolean

Dim instance As IRayTraceRenderer
Dim ImageFileName As String
Dim Width As Integer
Dim Height As Integer
Dim value As Boolean
 
value = instance.RenderToFile(ImageFileName, Width, Height)

bool RenderToFile( 
   string ImageFileName,
   int Width,
   int Height
)

bool RenderToFile( 
&   String^ ImageFileName,
&   int Width,
&   int Height
) 

Parameters

ImageFileName

File location, name, and format extension to which to save the current view of the rendered model (see Remarks)

Width

Width of image in pixels (see Remarks)

Height

Height of image in pixels (see Remarks)

Return Value

To override the format set in IRayTraceRenderer::ImageFormat, specify the file format extension in ImageFileName. Otherwise, omit the file format extension when specifying a value for ImageFileName.

Supported file formats:

• Flexible Precision Image Format (*.flx)
• Targa (*.tga)
• Windows BMP (*.bmp)
• Radiance High Dynamic Range HDR (*.hdr)
• JPEG 2000, JPEG 2000 16-Bit, and JPEG 2000 16-Bit Lossless (*.jp2)
• JPEG (*.jpg)
• Portable Network Graphic PNG and Portable Network Graphic PNG 16-Bit (*.png)
• SGI RGB (*.sgi)
• Tagged Image Format File TIF, 16-Bit TIF, and 16-Bit Uncompr. TIF (*.tif)
• Open EXR Half 16-Bit, OpenEXR Flat 32-bit, OpenEXR Tiled Half 16-bit, and OpenEXR Tiled Flat 32-bit (*.exr)

For example:

status=swRayTraceRenderer.RenderToFile("c:\temp\bracket_auto_manual_best.bmp", 0, 0)

renders a file of format Windows Bitmap.

status=swRayTraceRenderer.RenderToFile("c:\temp\bracket_auto_manual_best", 0, 0)

renders a file of format set by IRayTraceRendererOptions::ImageFormat.

You can override the values set in IRayTraceRendererOptions::ImageWidth and IRayTraceRendererOptions::ImageHeight by specifying values for the Width and Height arguments. Otherwise, set the Width and Height arguments to 0 to use the values set in IRayTraceRendererOptions::ImageWidth and IRayTraceRendererOptions::ImageHeight.