#include <xsi_renderercontext.h>
Inheritance diagram for RendererContext:
Public Member Functions |
|
| RendererContext () | |
| ~RendererContext () | |
| RendererContext (const CRef &in_ref) | |
| RendererContext (const RendererContext &in_obj) | |
| bool | IsA (siClassID in_ClassID) const |
| siClassID | GetClassID () const |
| RendererContext & | operator= (const RendererContext &in_obj) |
| RendererContext & | operator= (const CRef &in_ref) |
| CTime | GetTime () const |
| unsigned int | GetSequenceIndex () const |
| unsigned int | GetSequenceLength () const |
| CStatus | ProgressUpdate (const CString &in_strProgressShort, const CString &in_strProgressLong, int in_iPercentage) |
| CStatus | NewFrame (unsigned int in_uiWidth, unsigned int in_uiHeight) |
| CStatus | NewFragment (const RendererImageFragment &in_fragment) |
| CStatus | TriggerEvent (siEventID in_eEventID, siRenderingType in_eRenderingType, const CTime &in_rTime, const CStringArray &in_filenames, siRenderFieldType in_eFieldType) |
| Property | GetRendererProperty (const CTime &in_rTime) |
| Framebuffer | GetDisplayFramebuffer () |
| CRefArray | GetFramebuffers () |
| RendererContext | ( | ) |
Default constructor.
| ~RendererContext | ( | ) |
Default destructor.
| RendererContext | ( | const CRef & | in_ref | ) |
Constructor.
| in_ref | constant reference object. |
| RendererContext | ( | const RendererContext & | in_obj | ) |
Copy constructor.
| in_obj | constant class object. |
| bool IsA | ( | siClassID | in_ClassID | ) | const [virtual] |
Returns true if a given class type is compatible with this API class.
| in_ClassID | class type. |
Reimplemented from Context.
| siClassID GetClassID | ( | ) | const [virtual] |
Returns the type of the API class.
Reimplemented from Context.
| RendererContext& operator= | ( | const RendererContext & | in_obj | ) |
Creates an object from another object.
| in_obj | constant class object. |
| RendererContext& operator= | ( | const CRef & | in_ref | ) |
Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.
| in_ref | constant class object. |
Reimplemented from Context.
| CTime GetTime | ( | ) | const |
Returns the time at which the render process is occurring. The renderer should use this to set the evaluation time for the scene data being rendered. In the case of field rendering, or motion blurring, this time should be used as the base for which to derive other time stops.
| unsigned int GetSequenceIndex | ( | ) | const |
Returns the zero-based index of the frame being rendered within the rendered sequence. The sequence starts at zero and counts in ascending order. For single-frame renders, this function always returns zero. For sequence renders the highest value is always one less than the return value of RendererContext::GetSequenceLength.
| unsigned int GetSequenceLength | ( | ) | const |
Returns the length of the sequence being rendered. For single frames, this function always returns 1.
| CStatus ProgressUpdate | ( | const CString & | in_strProgressShort, | |
| const CString & | in_strProgressLong, | |||
| int | in_iPercentage | |||
| ) |
Notifies XSI as to what the current status of the rendering process is.
| in_strProgressShort | Short progress message (when using the small progress bar). | |
| in_strProgressLong | Longer progress message (when using the big progress bar or the render viewer). | |
| in_iPercentage | The percentage of the job done, if it can be indicated, or -1 |
| CStatus NewFrame | ( | unsigned int | in_uiWidth, | |
| unsigned int | in_uiHeight | |||
| ) |
Notifies the render manager that a new frame is about to be sent to whichever render viewer might be listening for frame fragments. In the case of field rendering, both frames should be sent to the viewer.
| in_uiWidth | The width of the new frame (needs to be the same as the value of the ImageWidth context parameter). |
|
| in_uiHeight | The height of the new frame (needs to be the same as the value of the ImageHeight context parameter). |
| CStatus NewFragment | ( | const RendererImageFragment & | in_fragment | ) |
Passes back a new frame fragment to the render manager. See RenderImageFragment for more details.
| in_fragment | The new RenderImageFragment |
| CStatus TriggerEvent | ( | siEventID | in_eEventID, | |
| siRenderingType | in_eRenderingType, | |||
| const CTime & | in_rTime, | |||
| const CStringArray & | in_filenames, | |||
| siRenderFieldType | in_eFieldType | |||
| ) |
Triggers a specific render event. At the moment only siOnBeginFrame, siOnEndFrame, siOnBeginSequence and siOnEndSequence are supported.
| in_eEventID | The event being called. | |
| in_eRenderingType | The type of rendering being performed. | |
| in_rTime | The time at which the render event is occurring. Only relevant for siOnBeginFrame and siOnEndFrame. | |
| in_filenames | The list of filenames being rendered out. In case of siOnBeginSequence and siOnEndSequence these should be time-independent filenames, which can be accessed by calling Framebuffer::GetResolvedFileName with no parameters. | |
| in_eFieldType | The field being rendered, or siRenderFieldNone if not rendering fields. |
CStatus::Abort The render was aborted while the event was being processed or the event requested an abort. The render should abort immediately at this point with a status code of CStatus::Fail.
Returns the renderer's option property evaluated at a specific time. Which particular property instance this is, is dependent upon who triggered the render (pass, region, shaderballs, etc.)
| in_rTime | The time to evaluate the property at. |
| Framebuffer GetDisplayFramebuffer | ( | ) |
Returns the Framebuffer object whose contents should be sent back as an image fragment to the render manager via RendererContext::NewFragment. If the Framebuffer object is not valid then no fragments are needed for viewing (for example when doing a command-line render or archive export). The display framebuffer also dictates the bit depth which the RenderImageFragment object should return its fragment data as. The object returned by this function is not guaranteed to be found in the list of Framebuffer objects returned by GetFramebuffers.
| CRefArray GetFramebuffers | ( | ) |
Returns all Framebuffer objects that should be rendered for the current frame.