Hide Table of Contents
RenderToFile Method (IRayTraceRenderer)

Saves the current view of the rendered model as an image to the specified file.

.NET Syntax

Visual Basic (Declaration) 
Function RenderToFile( _
   ByVal ImageFileName As System.String, _
   ByVal Width As System.Integer, _
   ByVal Height As System.Integer _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As IRayTraceRenderer
Dim ImageFileName As System.String
Dim Width As System.Integer
Dim Height As System.Integer
Dim value As System.Boolean
 
value = instance.RenderToFile(ImageFileName, Width, Height)
C# 
System.bool RenderToFile( 
   System.string ImageFileName,
   System.int Width,
   System.int Height
)
C++/CLI 
System.bool RenderToFile( 
&   System.String^ ImageFileName,
&   System.int Width,
&   System.int Height
) 

Parameters

ImageFileName
File path and name (see Remarks)
Width
Width of image in pixels (see Remarks)
Height
Height of image in pixels (see Remarks)

Return Value

True if the current view of the rendered model is saved, false if not

Example

Remarks

Before calling this method:

You can override the values set in IRayTraceRendererOptions::ImageWidth and IRayTraceRendererOptions::ImageHeight by calling this method with specific values for Width and Height. Set Width and Height to 0 to use values specified by IRayTraceRendererOptions::ImageWidth and IRayTraceRendererOptions::ImageHeight.

After calling this method, call IRayTraceRenderer::CloseRayTraceRender.

 

See Also

Availability

SOLIDWORKS 2011 FCS, Revision Number 19.0


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   RenderToFile Method (IRayTraceRenderer)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2016 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.