 | |
Raw | |
RawImageData class contains image metadata and raw image data that is stored in the Data byte array.
Inheritance HierarchySystemObject
Ab4d.SharpEngine.CommonRawImageData
Ab4d.SharpEngine.CommonRawImageData
Namespace: Ab4d.SharpEngine.Common
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.2.9386+3a404a3e1ebfa4efd231da7fe6f10dfb23b95dc4
SyntaxC#
public class RawImageData
The RawImageData type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RawImageData(Int32, Int32, Int32, Color4, Format) | Creates the RawImageData and fills the Data array with the specified fillColor. |
| RawImageData(Int32, Int32, Int32, Format, Byte, Boolean) | Constructor |
Properties| Name | Description | |
|---|---|---|
 | Data | Gets the byte array with image data. |
 | Empty | Gets a RawImageData with empty Data array and Width and Height set to zero and Format set to Bgra. |
| Format | Gets the image format. To change the format, call the ChangeFormat(Format) method. |
| HasTransparentPixels | Nullable Boolean that can specify if the image data contains transparent pixels (alpha value is less then 1 for at least one pixel). |
| Height | Gets the image height in pixels. To change the size, call the Resize(Int32, Int32, Int32, Int32, Boolean) method. |
| IsPreMultipliedAlpha | Nullable Boolean that can specify if the image data contains pre-multiplied alpha colors (colors are multiplied by alpha value). |
| OneBlackPixelImage | Gets a static 1 x 1 bitmap data with one black pixel with alpha set to 1 and Format set to Bgra. |
| Stride | Gets the image stride in bytes (length of one data row). To change the size, call the Resize(Int32, Int32, Int32, Int32, Boolean) method. |
| Width | Gets the image width in pixels. To change the size, call the Resize(Int32, Int32, Int32, Int32, Boolean) method. |
Methods| Name | Description | |
|---|---|---|
| ChangeFormat | Changes the value of the Format property. This does not change the data. |
| CheckTransparency | CheckTransparency method checks the data of the image for transparent pixels and returns true in case any transparent pixel is find. It also sets the HasTransparency property. |
| CheckTransparencyAndConvertToPremultipliedAlpha | CheckTransparencyAndConvertToPremultipliedAlpha method converts the colors by multiplying the red, green and blue values by alpha value. This produces the pre-multiplied colors. The method also checks the data of the image for transparent pixels and returns true in case any transparent pixel is find. It also sets the HasTransparency property. |
| CheckTransparentPixels | CheckTransparentPixels returns true when the image data contains transparent pixels (where alpha is less the 1); for fully opaque image false is returned. |
| Clear | Clears this RawImageData with the specified color. |
| Clone | Returns a cloned RawImageData with copied data array. |
| ConvertToPremultipliedAlpha | ConvertToPremultipliedAlpha method converts the colors by multiplying the red, green and blue values by alpha value. This produces the pre-multiplied colors. |
| DrawImage | DrawImage method draws the specified RawImageData into this RawImageData at the specified x and y offsets. |
| GetBytesPerPixel | Returns number of bytes that is required to store the specified format. The method can get results only for the following formats: R8G8B8A8Unorm, B8G8R8A8Unorm, R8G8B8Unorm, B8G8R8Unorm, R8Unorm. Other formats will throw an exception. |
| GetColor | Returns the color as uint value at the specified position. |
| GetColor4 | Returns the color as Color4 value at the specified position. |
| GetColor4Relative | Returns the color as Color4 value at the specified relative position (x and y should be in range from 0 to 1). |
| GetColorRelative | Returns the color as uint value at the specified relative position (x and y should be in range from 0 to 1). |
| GetFormatProperties | GetFormatProperties sets the hasAlpha, pixelSize and alphaOffset properties from the image format. The method returns false when the format is not known. |
| RemovePremultipliedAlpha | RemovePremultipliedAlpha method converts pre-multiplied alpha colors to non-pre-multiplied colors. This is done when IsPreMultipliedAlpha is not false and when format is B8G8R8A8Unorm or R8G8B8A8Unorm. After that the IsPreMultipliedAlpha is set to false. |
| Resize | Creates a new Data array with new dataLength and updates the Width, Height and Stride properties (Format value is preserved). |
| SetColor | Set the color at the specified position |
| SetColor4 | Set the color at the specified position |
| SetColor4Relative | Set the color at the specified relative position (x and y should be in range from 0 to 1). |
| SetColorRelative | Set the color at the specified relative position (x and y should be in range from 0 to 1). |
| SwapRedAndBlueColors | SwapRedAndBlueColors converts RGBA to BGRA and vice versa. |
See Also