Skip to content

Commit 59bd413

Browse files
update to internal commit 293cf05a
1 parent 956dfbc commit 59bd413

File tree

5 files changed

+55
-7
lines changed

5 files changed

+55
-7
lines changed

programming/cplusplus/api-reference/core/enum-image-pixel-format.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ typedef enum ImagePixelFormat
4747
IPF_ABGR_16161616,
4848
/** 24bit with BGR channel order stored in memory from high to low address. */
4949
IPF_BGR_888,
50-
/** 0:Black, 255:White. */
50+
/** 8-bit binary. 0:Black, 255:White. Foreground (bars) are black, background (spaces) are white. */
5151
IPF_BINARY_8,
5252
/**NV12 */
5353
IPF_NV12,
54-
/**0:White, 255:Black */
54+
/** 8-bit binary. 0:Black, 255:White. Foreground (bars) are white, background (spaces) are black. */
5555
IPF_BINARY_8_INVERTED
5656
}ImagePixelFormat;
5757
```

programming/dotnet/api-reference/core/enum-image-pixel-format.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ public enum EnumImagePixelFormat
4242
IPF_ABGR_16161616,
4343
/** 24bit with BGR channel order stored in memory from high to low address. */
4444
IPF_BGR_888,
45-
/** 0:Black, 255:White. */
45+
/** 8-bit binary. 0:Black, 255:White. Foreground (bars) are black, background (spaces) are white. */
4646
IPF_BINARY_8,
4747
/**NV12 */
4848
IPF_NV12,
49-
/**0:White, 255:Black */
49+
/**8-bit binary. 0:Black, 255:White. Foreground (bars) are white, background (spaces) are black. */
5050
IPF_BINARY_8_INVERTED
5151
}
5252
```

programming/dotnet/api-reference/utility/image-io.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,11 @@ class ImageIO : IDisposable
2424
| Method | Description |
2525
|----------------------|-------------|
2626
| [`ReadFromBase64String`](#readfrombase64string) | Reads an image from a base64 encoded string. |
27+
| [`ReadFromBitmap`](#readfrombitmap) | Reads an image from a `Bitmap` instance. |
2728
| [`ReadFromFile`](#readfromfile) | Reads an image from a file. |
2829
| [`ReadFromMemory`](#readfrommemory) | Reads an image from a file in memory. |
2930
| [`SaveToBase64String`](#savetobase64string) | Saves an image to a base64 encoded string. |
31+
| [`SaveToBitmap`](#savetobitmap) | Saves an image into a `Bitmap` instance. |
3032
| [`SaveToFile`](#savetofile) | Saves an image to a file. |
3133
| [`SaveToMemory`](#savetomemory) | Saves an image to a file in memory. |
3234

@@ -56,6 +58,28 @@ If the file format is gif, pdf or tiff, we read the first page of the image file
5658

5759
[ImageData]({{ site.dcvb_dotnet_api }}core/basic-classes/image-data.html)
5860

61+
### ReadFromBitmap
62+
63+
Reads an image from a `Bitmap` instance.
64+
65+
```csharp
66+
ImageData ReadFromBitmap(Bitmap bitmap, out int errorCode)
67+
```
68+
69+
**Parameters**
70+
71+
`[in] bitmap` The source bitmap to read from.
72+
73+
`[out] errorCode` The error code.
74+
75+
**Return value**
76+
77+
Returns an `ImageData` object representing the image if succeeds, null otherwise.
78+
79+
**See Also**
80+
81+
[ImageData]({{ site.dcvb_dotnet_api }}core/basic-classes/image-data.html)
82+
5983
### ReadFromFile
6084

6185
Reads an image from a file.
@@ -139,6 +163,28 @@ Returns an integer indicating the success of the operation. 0 indicates success,
139163

140164
[ImageFileFormat]({{ site.dcvb_dotnet_api }}core/enum-image-file-format.html)
141165

166+
### SaveToBitmap
167+
168+
Saves an image into a `Bitmap`.
169+
170+
```csharp
171+
int SaveToBitmap(ImageData imageData, out Bitmap bitmap)
172+
```
173+
174+
**Parameters**
175+
176+
`[in] imageData` The image data to be saved.
177+
178+
`[in] bitmap` A `Bitmap` instance that represents an image.
179+
180+
**Return value**
181+
182+
Returns an integer indicating the success of the operation. 0 indicates success, while a non-zero value indicates an error occurred.
183+
184+
**See Also**
185+
186+
[ImageData]({{ site.dcvb_dotnet_api }}core/basic-classes/image-data.html)
187+
142188
### SaveToFile
143189

144190
Saves an image to a file.

programming/java/api-reference/core/enum-image-pixel-format.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ public @interface EnumImagePixelFormat {
3939
int IPF_ABGR_16161616 = 11;
4040
//24bit with BGR channel order stored in memory from high to low address
4141
int IPF_BGR_888 = 12;
42-
//0:Black, 255:White
42+
//8-bit binary. 0:Black, 255:White. Foreground (bars) are black, background (spaces) are white.
4343
int IPF_BINARY_8 = 13;
4444
//NV12
4545
int IPF_NV12 = 14;
46-
//0:White, 255:Black (inverted binary 8-bit)
46+
//8-bit binary. 0:Black, 255:White. Foreground (bars) are white, background (spaces) are black.
4747
int IPF_BINARY_8_INVERTED = 15;
4848
}
4949
```

programming/python/api-reference/core/enum-image-pixel-format.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,10 @@ class EnumImagePixelFormat(IntEnum):
3838
IPF_ABGR_16161616
3939
#24bit with BGR channel order stored in memory from high to low address
4040
IPF_BGR_888
41-
#0:Black, 255:White
41+
#8-bit binary. 0:Black, 255:White. Foreground (bars) are black, background (spaces) are white.
4242
IPF_BINARY_8
4343
#NV12
4444
IPF_NV12
45+
#8-bit binary. 0:Black, 255:White. Foreground (bars) are white, background (spaces) are black.
46+
IPF_BINARY_8_INVERTED
4547
```

0 commit comments

Comments
 (0)