BitmapDrawable Class
A drawable implemented as a memory-resident bitmap.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Thread safety: Members defined in this class are, in general, not thread-safe. Show
Syntax
public class BitmapDrawable : DrawableRemarks
A BitmapDrawable is a memory-resident, off-screen bitmap that can be drawn on. It is typically used to generate map images and save them to disk files or memory buffers.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
Drawable
BitmapDrawable
Platforms
Windows, Linux, Android
BitmapDrawable Members
The BitmapDrawable type has the following members.
Constructors
| Name | Description |
|---|---|
| BitmapDrawable | Initializes a new instance of the BitmapDrawable class. |
Properties
| Name | Description |
|---|---|
| Background | Gets or sets the background color of the drawable. Inherited from Drawable |
| FogColor | Gets or sets the color of the fog in a 3D view. Inherited from Drawable |
| FogDensity | Gets or sets the density of the fog in a 3D view. Inherited from Drawable |
| Height | Gets or sets the height of the drawable in pixels. Inherited from Drawable |
| IsDisposed | Gets a value that tells whether the current BitmapDrawable has been disposed. Inherited from EngineObject |
| Name | Gets or sets the name of the BitmapDrawable. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current BitmapDrawable represents. Inherited from EngineObject |
| PixelSize | Gets or sets a drawable-specific pixel size. Inherited from Drawable |
| PixelSizeAdjustments | Gets or sets a number of parameters that adjusts rendering to the DPI of the display. Inherited from Drawable |
| Renderer | Gets the type of graphics renderer used by the drawable. Inherited from Drawable |
| RendererSettings | Gets or sets a number of parameters that adjusts renderer settings. Inherited from Drawable |
 ScreenPixelSize | Gets or sets the size of a screen pixel. Inherited from Drawable |
| Swap | Gets or sets a flag indicating if the front and back buffers of the drawable are swapped automatically. Inherited from Drawable |
| Transform | Gets or sets the current 2D affine transform. Inherited from Drawable |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
| Width | Gets or sets the width of the drawable in pixels. Inherited from Drawable |
| Wireframe | Gets or sets a flag indicating that meshes in 3D should be drawn as wireframes. Inherited from Drawable |
Methods
| Name | Description |
|---|---|
| AdjustSize | Adjusts the drawable to the specified width and height. Inherited from Drawable |
| Clone | Creates a copy of an object. Inherited from EngineObject |
| CreateSnapshot | Creates a bitmap copy of the drawable, a "snapshot". Inherited from Drawable |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| DrawArc | Draws an elliptic arc. Inherited from Drawable |
| DrawLine | Draws a line with the specified geometry and pen. Inherited from Drawable |
| DrawPolygon | Draws a polygon with the specified brush and pen. Inherited from Drawable |
| DrawRaster | Draws a raster. Inherited from Drawable |
| DrawSnapshot | Draws a snapshot created by CreateSnapshot. Inherited from Drawable |
| DrawString | Draws a text string. Inherited from Drawable |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| GetImage | Overloaded. Saves the contents of the drawable to a memory buffer, possibly with georeferencing information. Inherited from Drawable |
| GetNativeRendererInfo | Retrieves information necessary to perform custom native rendering. Inherited from Drawable |
| GetRaster | Copies all pixels in the drawable into a new Raster and returns it. Inherited from Drawable |
| Save | Overloaded. Saves the contents of the drawable to a file, possibly with georeferencing information. Inherited from Drawable |
| SetPropertiesFrom | Reserved for internal use. Inherited from Drawable |
| SwapBuffers | Swaps the front and back buffers of the drawable. Inherited from Drawable |
| TextBounds | Calculates the bounding box of a text string if drawn with DrawString. Inherited from Drawable |
Events
| Name | Description |
|---|---|
| FrameCompleted | Reserved for internal use. Inherited from Drawable |