[This is preliminary documentation and is subject to change.]
Class that describes an individual instance of a configured brush.
Each brush instance will only be used for one DrawOperation, so it can store state.
Stateless brush types may combine IBrush and IBrushInstance into one class.
Namespace: fCraft.DrawingAssembly: fCraft (in fCraft.dll) Version: 0.6.2.4 (0.6.2.4)
Syntax
| C# |
public interface IBrushInstance
Members
| All Members | Properties  | Methods  |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| Begin(Player, DrawOperation) | Called when the DrawOperation starts. Should be used to verify that the brush is ready for use.
Resources used by the brush should be obtained here. |
| Brush | Configured brush that created this instance. |
| End()()()() | Called when the DrawOperation is done or cancelled.
Resources used by the brush should be freed/disposed here. |
| HasAlternateBlock | Whether the brush is capable of providing alternate blocks (e.g. for filling hollow DrawOps). |
| InstanceDescription | A compact readable summary of brush type, configuration, and state. |
| NextBlock(DrawOperation) | Provides the next Block type for the given DrawOperation. |
