C# / .Net API Library Reference  4.3.2-74-ge1d4cca
Public Functions
IRemoteRenderer Interface Reference

The IRemoteRenderer interface provides methods to notify StateManager when to render an image to a remoted view, as well as methods to configure the format of the rendered images before streaming. The methods in this interface expect the view's name as a parameter. This is the name you chose for the applicable view when you registered it using RegisterView.

Public Functions

ViewImageFormat GetViewImageFormat (string viewName)
 
void RenderViewDeferred (string viewName)
 
void RenderViewImmediate (string viewName)
 
void SetViewImageFormat (string viewName, ViewImageFormat format)
 
void SetViewInteracting (string viewName, bool isInteracting)
 

Usage Description

ViewImageFormat GetViewImageFormat ( string  viewName)

Returns the current view image format (pixel format, scan line order and alignment) for the specified view.

Implemented in ViewManager.

void RenderViewDeferred ( string  viewName)

Notifies StateManager that the image in the specified view has been updated and needs to be rendered. The view image bits will be acquired later via the view's IRenderedView interface (the timing of the call to RenderView is not configurable; this is handled automatically by PureWeb).

Implemented in ViewManager.

void RenderViewImmediate ( string  viewName)

Notifies StateManager that the image in the specified view has been updated needs to be rendered. The view image bits will be acquired immediately via the view's IRenderedView interface. This must be called on the UI thread.

Implemented in ViewManager.

void SetViewImageFormat ( string  viewName,
ViewImageFormat  format 
)

Sets the view image format (pixel format, scan line order and alignment) for the specified view.

The main purpose of this method is to overwrite framework defaults when needed.

Implemented in ViewManager.

void SetViewInteracting ( string  viewName,
bool  isInteracting 
)

Sets the interactive mode for the specified view to either true or false.

The SetViewInteracting method is used to notify StateManager when user interaction begins and when it stops. For example, you could set the interactive mode to true on a mouse down event, and set it back to false on a mouse up event. Once this is in place, you can configure the image quality values for the interactive and non-interactive modes using the client-side APIs.

Implemented in ViewManager.