API Search || Global Search
HPS.D3DImageCanvas Class Reference
Inheritance diagram for HPS.D3DImageCanvas:
HPS.Canvas HPS.Sprocket HPS.Object

Public Member Functions

 D3DImageCanvas (HPS.OffScreenWindowOptionsKit in_options, string in_name, int in_width=800, int in_height=800)
 Constructs a new D3DImageCanvas. More...
 
override void Dispose ()
 
virtual void OnSizeChanged (object sender, Size in_new_size, bool in_do_resize)
 Intended for forwarding of resize events from the parent window and throttling them to ensure not too many updates are performed while the window is being resized rapidly. More...
 
- Public Member Functions inherited from HPS.Canvas
void Assign (HPS.Canvas in_that)
 
void AttachLayout (HPS.Layout in_layout)
 Attaches a layout to this HPS.Canvas. There can only be one layout per HPS.Canvas. If a Layout is already attached to this Canvas, the new Layout will replace the old one. More...
 
void AttachViewAsLayout (HPS.View in_view)
 Attaches a View to this HPS.Canvas using an implicit Layout that convers the whole window. If a Layout is already attached to this Canvas, the new Layout will replace the old one. More...
 
 Canvas (HPS.Canvas that)
 
void Delete ()
 Deletes this Canvas, and the Window that backs it. If the Canvas has Layouts attached, they are not destroyed. More...
 
void DetachLayout ()
 Detaches the Layout from this Canvas. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Canvas in_that)
 
HPS.Layout GetAttachedLayout ()
 Returns the Layout that is currently attached to this Canvas. More...
 
HPS.IncludeKey GetAttachedLayoutIncludeLink ()
 Returns the IncludeKey that attaches the current layout to this Canvas. More...
 
float GetFrameRate ()
 Returns true if frame rate is active for this HPS.Canvas. More...
 
HPS.View GetFrontView ()
 Views can overlap. This function returns a reference to the frontmost View. More...
 
override int GetHashCode ()
 
string GetName ()
 Get the name used when creating this Canvas. More...
 
HPS.PortfolioKey GetPortfolioKey ()
 Returns the HPS.PortfolioKey associated with this Canvas' SegmentKey. More...
 
HPS.WindowKey GetWindowKey ()
 Each of the four display hierarchy objects (HPS.Canvas, HPS.Layout, HPS.View, HPS.Model) are backed by a HPS.SegmentKey. This function returns the HPS.SegmentKey that is associated with this Canvas. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void SetFrameRate (float in_frame_rate)
 Sets the minimum frame rate for this HPS.Canvas in number of frames per second. More...
 
void SetFrameRate ()
 Sets the minimum frame rate for this HPS.Canvas in number of frames per second. More...
 
void Update ()
 Redraws the entire Canvas, including all of its child components using the default options. More...
 
void Update (HPS.Window.UpdateType in_type, double in_time_limit)
 Redraws the entire Canvas, including all of its child components using the specified parameters. More...
 
void Update (HPS.Window.UpdateType in_type)
 Redraws the entire Canvas, including all of its child components using the specified parameters. More...
 
HPS.UpdateNotifier UpdateWithNotifier ()
 Redraws the entire Canvas, including all of its child components using the default options, and also returns a notifier to facilitate tracking the update progress. More...
 
HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateType in_type, double in_time_limit)
 Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an More...
 
HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateType in_type)
 Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

Properties

ImageSource ImageSource [get]
 The associated ImageSource containing the rendered canvas content. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Canvas
static bool operator!= (HPS.Canvas a, HPS.Canvas b)
 
static bool operator== (HPS.Canvas a, HPS.Canvas b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Member Functions inherited from HPS.Canvas
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Sprocket
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Constructor & Destructor Documentation

HPS.D3DImageCanvas.D3DImageCanvas ( HPS.OffScreenWindowOptionsKit  in_options,
string  in_name,
int  in_width = 800,
int  in_height = 800 
)
inline

Constructs a new D3DImageCanvas.

Parameters
in_optionsOptions for the underlying offscreen window.
in_nameAn optional name for the canvas.
in_widthThe desired initial canvas width in pixels.
in_heightThe desired initial canvas height in pixels.

Member Function Documentation

virtual void HPS.D3DImageCanvas.OnSizeChanged ( object  sender,
Size  in_new_size,
bool  in_do_resize 
)
inlinevirtual

Intended for forwarding of resize events from the parent window and throttling them to ensure not too many updates are performed while the window is being resized rapidly.

Parameters
sender
in_new_sizeThe new size in pixels.
in_do_resizeRequest an update on the next internal size timer tick (200ms interval).

Property Documentation

ImageSource HPS.D3DImageCanvas.ImageSource
get

The associated ImageSource containing the rendered canvas content.


The documentation for this class was generated from the following file:
  • internals/hps_sprk_d3dimage/source/cs/HPS.D3DImageCanvas.cs