shbeu.h File Reference

The libshbeu C API. More...

Go to the source code of this file.

Data Structures

struct  ren_vid_rect
 Bounding rectange. More...
struct  ren_vid_surface
 Surface. More...
struct  format_info
struct  shbeu_surface
 Surface specification. More...

Typedefs

typedef struct SHBEU SHBEU

Enumerations

enum  ren_vid_format_t {
  REN_UNKNOWN, REN_NV12, REN_NV16, REN_RGB565,
  REN_RGB24, REN_BGR24, REN_RGB32, REN_ARGB32
}
 

Surface formats.

More...

Functions

SHBEU * shbeu_open (void)
 Open a BEU device.
SHBEU * shbeu_open_named (const char *name)
 Open a BEU device with the specified name.
void shbeu_close (SHBEU *beu)
 Close a BEU device.
int shbeu_start_blend (SHBEU *beu, const struct shbeu_surface *src1, const struct shbeu_surface *src2, const struct shbeu_surface *src3, const struct shbeu_surface *dest)
 Start a surface blend.
void shbeu_wait (SHBEU *beu)
 Wait for a BEU operation to complete.
int shbeu_blend (SHBEU *beu, const struct shbeu_surface *src1, const struct shbeu_surface *src2, const struct shbeu_surface *src3, const struct shbeu_surface *dest)
 Perform a surface blend.

Detailed Description

The libshbeu C API.


Enumeration Type Documentation

Surface formats.

Enumerator:
REN_NV12 

YCbCr420: Y plane, packed CbCr plane, optional alpha plane.

REN_NV16 

YCbCr422: Y plane, packed CbCr plane, optional alpha plane.

REN_RGB565 

Packed RGB565.

REN_RGB24 

Packed RGB888.

REN_BGR24 

Packed BGR888.

REN_RGB32 

Packed XRGB8888 (most significant byte ignored).

REN_ARGB32 

Packed ARGB8888.


Function Documentation

int shbeu_blend ( SHBEU *  beu,
const struct shbeu_surface src1,
const struct shbeu_surface src2,
const struct shbeu_surface src3,
const struct shbeu_surface dest 
)

Perform a surface blend.

See shbeu_start_blend for parameter definitions.

void shbeu_close ( SHBEU *  beu  ) 

Close a BEU device.

Parameters:
beu BEU handle
SHBEU* shbeu_open ( void   ) 

Open a BEU device.

Return values:
0 Failure, otherwise BEU handle
SHBEU* shbeu_open_named ( const char *  name  ) 

Open a BEU device with the specified name.

If more than one BEU is available on the platform, each BEU has a name such as 'BEU0', 'BEU1', and so on. This API will allow to open a specific BEU by shbeu_open_named("BEU0") for instance.

Return values:
0 Failure, otherwise BEU handle.
int shbeu_start_blend ( SHBEU *  beu,
const struct shbeu_surface src1,
const struct shbeu_surface src2,
const struct shbeu_surface src3,
const struct shbeu_surface dest 
)

Start a surface blend.

Parameters:
beu BEU handle
src1 Parent surface. The output will be this size.
src2 Overlay surface. Can be NULL, if no overlay required.
src3 Overlay surface. Can be NULL, if no overlay required.
dest Output surface.
Return values:
0 Success
-1 Error
void shbeu_wait ( SHBEU *  beu  ) 

Wait for a BEU operation to complete.

The operation is started by a call to shbeu_start_blend.

Parameters:
beu BEU handle
Generated on Fri Aug 26 14:44:37 2011 for libshbeu by  doxygen 1.6.3