KGy SOFT Drawing Libraries Help
Custom
Represents the configuration of an indexed custom bitmap data that can be created by the CreateBitmapData
methods that have a CustomIndexedBitmapDataConfig parameter.
Definition
Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.2.0
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.2.0
C#
public sealed class CustomIndexedBitmapDataConfig : CustomBitmapDataConfigBaseVB
Public NotInheritable Class CustomIndexedBitmapDataConfig
Inherits CustomBitmapDataConfigBaseC++
public ref class CustomIndexedBitmapDataConfig sealed : public CustomBitmapDataConfigBaseF#
[<SealedAttribute>]
type CustomIndexedBitmapDataConfig =
class
inherit CustomBitmapDataConfigBase
end- Inheritance
- Object CustomBitmapDataConfigBase CustomIndexedBitmapDataConfig
Remarks
The PixelFormat property and at least either the RowGetColorIndex or the RowSetColorIndex property must be set to create a valid custom bitmap data.
If RowSetColorIndex is not set, then the custom bitmap data will be read-only. And if RowGetColorIndex is not set, then the custom bitmap data will be write-only.
The delegates should not reference or capture the back buffer directly. Instead, they should use the ICustomBitmapDataRow property of the accessor delegates to access the bitmap data. If this is true for both of the accessor delegates you can set the BackBufferIndependentPixelAccess property to provide better performance and quality in case of certain operations.
Constructors
| CustomIndexedBitmapDataConfig | Initializes a new instance of the CustomIndexedBitmapDataConfig class |
Properties
| BackBufferIndependentPixelAccess |
Gets or sets whether the pixel accessor delegates are not tied to a specific buffer instance or memory location but can work with any buffer.
If the pixel accessor delegates do not capture any specific buffer instance and access the bitmap data only by the ICustomBitmapDataRow
parameter of the delegate, then it is safe to set this property to .
Default value: . (Inherited from CustomBitmapDataConfigBase) |
| DisposeCallback |
Gets or sets a delegate that will be called when the created custom bitmap data is disposed.
Default value: . (Inherited from CustomBitmapDataConfigBase) |
| Palette |
Gets or sets the desired Palette of the created custom bitmap data.
It determines also the BackColor and AlphaThreshold properties of the result.
It can contain less colors than the specified PixelFormat can handle.
Default value: . See the Remarks section of the CreateBitmapDataT(T, Size, Int32, CustomIndexedBitmapDataConfig) method for more details. |
| PixelFormat |
Gets or sets the pixel format of the custom bitmap data to create. This property must be set to a nondefault value to create a valid custom bitmap data
by the CreateBitmapData methods.
Default value: The default value of PixelFormatInfo, which represents the Undefined format. (Inherited from CustomBitmapDataConfigBase) |
| RowGetColorIndex |
Gets or sets a delegate that can retrieve a pixel of a row in the custom bitmap data as a palette index.
Make sure you access the row content via the ICustomBitmapDataRow parameter of the delegate.
Default value: . |
| RowSetColorIndex |
Gets or sets a delegate that can set a pixel of a row in the custom bitmap from a palette index.
Make sure you access the row content via the ICustomBitmapDataRow parameter of the delegate.
Default value: . |
| TrySetPaletteCallback |
Gets or sets a delegate that will be invoked when the TrySetPalette extension method is called.
If the bitmap data to create belongs to a bitmap of a 3rd party library, then this delegate can be used to update the actual palette of the actual bitmap.
Default value: . |