iImageData

You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30.

Stores the image data.

Objective-C
Swift

```
@interface iImageData : NSObject 
```
```
class iImageData : NSObject
```

Attributes

Attribute	Type	Description
`bytes`	NSData*	The array of bytes that stores the pixel buffer of the image.
`width`	NSInteger	The width of the image in pixels.
`height`	NSInteger	The height of the image in pixels.
`stride`	NSInteger	The stride is measured by the byte length of each line in the pixel buffer.
`format`	NSInteger	The image pixel format used in the image byte array. View `EnumImagePixelFormat` for all supported image pixel formats.
`orientation`	NSInteger	The orientation of the image buffer contained in this frame data.

Methods

Method	Description
`toUIImage`	Convert the `ImageData` object to a `UIImage` object.

bytes

The image data content in a byte array.

Objective-C
Swift

```
NSData* bytes
```
```
var bytes: Data? { get set }
```

width

The width of the image in pixels.

Objective-C
Swift

```
NSInteger width
```
```
var width: Int { get set }
```

height

The height of the image in pixels.

Objective-C
Swift

```
NSInteger height
```
```
var height: Int { get set }
```

stride

The stride (or scan width) of the image.

Objective-C
Swift

```
NSInteger stride
```
```
var stride: Int { get set }
```

format

The image pixel format used in the image byte array.

Objective-C
Swift

```
EnumImagePixelFormat format
```

var format: EnumImagePixelFormat { get set }

orientation

The orientation of the image buffer contained in this frame data. The value is the angle that the camera image needs to be rotated clockwise so it shows correctly on the display in its natural orientation. It is 0, 90, 180, or 270. A typical value for this is 90 as most camera modules record the frames in landscape right orientation. Rotating a landscape right frame by 90 degrees will show it correctly on the display in portrait orientation (which is the natural device orientation of most phones).

Objective-C
Swift

```
NSInteger orientation
```
```
var orientation: Int { get set }
```

toUIImage

Convert the ImageData object to a UIImage object.

Objective-C
Swift

- (UIImage * _Nullable)toUIImage:(NSError *_Nullable *_Nullable)error;

```
func toUIImage() throws -> UIImage
```

Return Value

A UIImage object.

Objective-C
Swift

NSError* error;
[imageData toUIImage:error];

do{
   try imageData.toUIImage()
}catch{
   // Add your code to deal with the exceptions.
}