Class Image

Namespace

easyar

Image stores image data, used to represent an image in memory. Image provides access to raw data in the form of a byte array, and also provides an interface to access information such as width and height. In all versions of EasyAR Sense, you can access image data. In iOS, you can access it like this:

#import <easyar/buffer.oc.h>
#import <easyar/image.oc.h>

easyar_OutputFrame * outputFrame = [outputFrameBuffer peek];
if (outputFrame != nil) {
    easyar_Image * i = [[outputFrame inputFrame] image];
    easyar_Buffer * b = [i buffer];
    char * bytes = calloc([b size], 1);
    memcpy(bytes, [b data], [b size]);
    // use bytes here
    free(bytes);
}

In Android,

import cn.easyar.*;

OutputFrame outputFrame = outputFrameBuffer.peek();
if (outputFrame != null) {
    InputFrame inputFrame = outputFrame.inputFrame();
    Image i = inputFrame.image();
    Buffer b = i.buffer();
    byte[] bytes = new byte[b.size()];
    b.copyToByteArray(0, bytes, 0, bytes.length);
    // use bytes here
    b.dispose();
    i.dispose();
    inputFrame.dispose();
    outputFrame.dispose();
}

Image

Constructors

Image

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_Image__ctor(easyar_Buffer * buffer, easyar_PixelFormat format, int width, int height, easyar_Image * * Return)

Image(std::shared_ptr<Buffer> buffer, PixelFormat format, int width, int height)

public Image(@Nonnull Buffer buffer, int format, int width, int height)

constructor(buffer: Buffer, format: Int, width: Int, height: Int)

+ (easyar_Image *) create:(easyar_Buffer *)buffer format:(easyar_PixelFormat)format width:(int)width height:(int)height

public convenience init(_ buffer: Buffer, _ format: PixelFormat, _ width: Int32, _ height: Int32)

public Image(Buffer buffer, PixelFormat format, int width, int height)

Parameters

Name	Type	Description
buffer	Buffer
format	PixelFormat
width	Int32
height	Int32

Methods

buffer

Returns the data buffer in the image. You can use the Buffer API to access the internal data. Do not modify the content of the obtained Buffer data, as it may be used in other threads.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_Image_buffer(const easyar_Image * This, easyar_Buffer * * Return)

std::shared_ptr<Buffer> buffer()

public @Nonnull Buffer buffer()

fun buffer(): Buffer

- (easyar_Buffer *)buffer

public func buffer() -> Buffer

public virtual Buffer buffer()

Returns

Type	Description
Buffer

format

Returns the image format.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

easyar_PixelFormat easyar_Image_format(const easyar_Image * This)

PixelFormat format()

public int format()

fun format(): Int

- (easyar_PixelFormat)format

public func format() -> PixelFormat

public virtual PixelFormat format()

Returns

Type	Description
PixelFormat

width

Returns the image width. There will be padding of pixelWidth-width pixels on the right side of the image data.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

int easyar_Image_width(const easyar_Image * This)

int width()

public int width()

fun width(): Int

- (int)width

public func width() -> Int32

public virtual int width()

Returns

Type	Description
Int32

height

Returns the image height. There will be padding of pixelHeight-height pixels below the image data.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

int easyar_Image_height(const easyar_Image * This)

int height()

public int height()

fun height(): Int

- (int)height

public func height() -> Int32

public virtual int height()

Returns

Type	Description
Int32

pixelWidth

Returns the pixel width used when encoding the image.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

int easyar_Image_pixelWidth(const easyar_Image * This)

int pixelWidth()

public int pixelWidth()

fun pixelWidth(): Int

- (int)pixelWidth

public func pixelWidth() -> Int32

public virtual int pixelWidth()

Returns

Type	Description
Int32

pixelHeight

Returns the pixel height used when encoding the image.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

int easyar_Image_pixelHeight(const easyar_Image * This)

int pixelHeight()

public int pixelHeight()

fun pixelHeight(): Int

- (int)pixelHeight

public func pixelHeight() -> Int32

public virtual int pixelHeight()

Returns

Type	Description
Int32

create

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_Image_create(easyar_Buffer * buffer, easyar_PixelFormat format, int width, int height, int pixelWidth, int pixelHeight, easyar_Image * * Return)

static std::shared_ptr<Image> create(std::shared_ptr<Buffer> buffer, PixelFormat format, int width, int height, int pixelWidth, int pixelHeight)

public static @Nonnull Image create(@Nonnull Buffer buffer, int format, int width, int height, int pixelWidth, int pixelHeight)

companion object fun create(buffer: Buffer, format: Int, width: Int, height: Int, pixelWidth: Int, pixelHeight: Int): Image

+ (easyar_Image *)create:(easyar_Buffer *)buffer format:(easyar_PixelFormat)format width:(int)width height:(int)height pixelWidth:(int)pixelWidth pixelHeight:(int)pixelHeight

public static func create(_ buffer: Buffer, _ format: PixelFormat, _ width: Int32, _ height: Int32, _ pixelWidth: Int32, _ pixelHeight: Int32) -> Image

public static Image create(Buffer buffer, PixelFormat format, int width, int height, int pixelWidth, int pixelHeight)

Parameters

Name	Type	Description
buffer	Buffer
format	PixelFormat
width	Int32
height	Int32
pixelWidth	Int32
pixelHeight	Int32

Returns

Type	Description
Image