Detailed Description
The Framebuffer object controls the file output of a RenderChannel object. It can be created using the Pass::CreateFramebuffer function.
The framebuffer format can be selected from the list of formats provided by the rendering engine selected on the framebuffer's Pass object.
- See also:
- RenderChannel SceneRenderProperty Pass
- Since:
- 6.0
- Example:
- This example demonstrates how to list all framebuffers from all passes and the resolved paths they point to.
#include <xsi_framebuffer.h>
List of all members.
Constructor & Destructor Documentation
Constructor.
- Parameters:
-
in_ref | constant reference object. |
Copy constructor.
- Parameters:
-
in_obj | constant class object. |
Member Function Documentation
bool IsA |
( |
siClassID |
in_ClassID | ) |
const [virtual] |
Returns true if a given class type is compatible with this API class.
- Parameters:
-
- Returns:
- true if the class is compatible, false otherwise.
Reimplemented from ProjectItem.
Returns the type of the API class.
- Returns:
- The class type.
Reimplemented from ProjectItem.
Creates an object from another object. The newly created object is set to empty if the input object is not compatible.
- Parameters:
-
in_obj | constant class object. |
- Returns:
- The new Framebuffer object.
Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.
- Parameters:
-
in_ref | constant class object. |
- Returns:
- The new Framebuffer object.
Reimplemented from ProjectItem.
Takes the output file name path template given in the framebuffer and resolves it, for the specified time, into a real path name and returns it as a CString. See section "Output Path Templates" in the Softimage User Guide for more details.
The in_rTime
parameter controls the result of the
[Frame] and
[Field] tokens.
- Parameters:
-
in_rTime | The time to resolve the path template at. |
- Returns:
- The resolved file name path template at the given time.
- See also:
- Pass::GetResolvedArchivePath XSIUtils.ResolveTokenString
- Since:
- 6.01
Takes the output file name path template given in the framebuffer and resolves it into a time-independent path, where any instance of
[Frame] is substituted with the a sequence of '#'
symbols, that represent the current frame number and padding width. See section "Output Path Templates" in the Softimage User Guide for more details.
- Returns:
- The time-independent resolved file name path template.
- See also:
- Pass::GetResolvedArchivePath XSIUtils.ResolveTokenString
- Since:
- 6.01
Returns a list of the available image output file formats that can be set for this framebuffer. The format selection is dependent on the current rendering engine and the channel type of the RenderChannel object represented by this framebuffer.
- Returns:
- A list of format extensions corresponding to the image file formats available to this framebuffer.
- See also:
- RenderChannel siRenderChannelType
Returns a list of the available output data types for the image output file format selected for this framebuffer.
- Returns:
- An array of data types for the selected image output format. Although the data type can be any string, many of them are predefined in siImageDataType.
- See also:
- RenderChannel siRenderChannelType siImageDataType
Returns the bit depth to use for returning color data back to Softimage for display at render time. This value will be passed to RendererImageFragment::GetScanlineRGBA when Softimage asks for image fragment data.
- Returns:
- A color bit depth for display data.
- See also:
- RendererImageFragment
- Since:
- 7.0
The documentation for this class was generated from the following file: