upipe-modules/upipe_blit.h header reference
Upipe module blitting subpictures into a main picture More
Header inclusion
Members
Types
- enum upipe_blit_command
- enum upipe_blit_sub_command
Functions
- struct upipe_mgr * upipe_blit_mgr_alloc(void )
- int upipe_blit_prepare(struct upipe *upipe, struct upump **upump_p)
- int upipe_blit_sub_get_alpha(struct upipe *upipe, uint8_t *alpha_p)
- int upipe_blit_sub_get_alpha_threshold(struct upipe *upipe, uint8_t *threshold_p)
- int upipe_blit_sub_get_rect(struct upipe *upipe, uint64_t *loffset_p, uint64_t *roffset_p, uint64_t *toffset_p, uint64_t *boffset_p)
- int upipe_blit_sub_get_z_index(struct upipe *upipe, int *z_index_p)
- int upipe_blit_sub_set_alpha(struct upipe *upipe, uint8_t alpha)
- int upipe_blit_sub_set_alpha_threshold(struct upipe *upipe, uint8_t threshold)
- int upipe_blit_sub_set_rect(struct upipe *upipe, uint64_t loffset, uint64_t roffset, uint64_t toffset, uint64_t boffset)
- int upipe_blit_sub_set_z_index(struct upipe *upipe, int z_index)
Description
Upipe module blitting subpictures into a main picture
Members detail
This macro is declared in upipe-modules/upipe_blit.h source file, line 39.
This macro is declared in upipe-modules/upipe_blit.h source file, line 40.
This macro is declared in upipe-modules/upipe_blit.h source file, line 32.
This enum is declared in upipe-modules/upipe_blit.h source file, line 51.
This enum extends upipe_command with specific commands for upipe_blit pipes.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_BLIT_SENTINEL | UPIPE_CONTROL_LOCAL | |
| UPIPE_BLIT_PREPARE | unknown | prepares the next picture to output (struct upump **) |
This function is declared in upipe-modules/upipe_blit.h source file, line 47.
This function returns the management structure for blit pipes.
The return value is pointer to manager
int upipe_blit_prepare(struct upipe *upipe, struct upump **upump_p)
This function is declared in upipe-modules/upipe_blit.h source file, line 93.
This function prepares the next picture to output.
Parameter list:
- upipe: description structure of the pipe
- upump_p: reference to pump that generated the buffer
The return value is an error code
This enum is declared in upipe-modules/upipe_blit.h source file, line 60.
This enum extends upipe_command with specific commands for upipe_blit_sub pipes.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_BLIT_SUB_SENTINEL | UPIPE_CONTROL_LOCAL | |
| UPIPE_BLIT_SUB_GET_RECT | unknown | gets the offsets of the rect onto which the input of this subpipe will be blitted (uint64_t *, uint64_t *, uint64_t *, uint64_t *) |
| UPIPE_BLIT_SUB_SET_RECT | unknown | sets the offsets of the rect onto which the input of this subpipe will be blitted (uint64_t, uint64_t, uint64_t, uint64_t) |
| UPIPE_BLIT_SUB_GET_ALPHA | unknown | gets the alpha channel multiplier (uint8_t *) |
| UPIPE_BLIT_SUB_SET_ALPHA | unknown | sets the alpha channel multiplier (uint8_t) |
| UPIPE_BLIT_SUB_GET_ALPHA_THRESHOLD | unknown | gets the method for alpha blending (uint8_t *) See also ubuf_pic_blit. |
| UPIPE_BLIT_SUB_SET_ALPHA_THRESHOLD | unknown | sets the method for alpha blending (uint8_t) See also ubuf_pic_blit. |
| UPIPE_BLIT_SUB_GET_Z_INDEX | unknown | gets the z-index (int *) |
| UPIPE_BLIT_SUB_SET_Z_INDEX | unknown | sets the z-index (int) |
This function is declared in upipe-modules/upipe_blit.h source file, line 143.
This function gets the multiplier of the alpha channel.
Parameter list:
- upipe: description structure of the pipe
- alpha_p: filled in with the mulitplier of the alpha channel
The return value is an error code
This function is declared in upipe-modules/upipe_blit.h source file, line 170.
This function gets the method for alpha blending for this subpipe.
Parameter list:
- upipe: description structure of the pipe
- threshold_p: filled in with method for alpha blending ()
The return value is an error code
int upipe_blit_sub_get_rect(struct upipe *upipe, uint64_t *loffset_p, uint64_t *roffset_p, uint64_t *toffset_p, uint64_t *boffset_p)
This function is declared in upipe-modules/upipe_blit.h source file, line 111.
This function gets the offsets (from the respective borders of the frame) of the rectangle onto which the input of the subpipe will be blitted.
Parameter list:
- upipe: description structure of the pipe
- loffset_p: filled in with the offset from the left border
- roffset_p: filled in with the offset from the right border
- toffset_p: filled in with the offset from the top border
- boffset_p: filled in with the offset from the bottom border
The return value is an error code
This function is declared in upipe-modules/upipe_blit.h source file, line 196.
This function gets the z-index for this subpipe.
Parameter list:
- upipe: description structure of the pipe
- z_index_p: filled in with z-index
The return value is an error code
This function is declared in upipe-modules/upipe_blit.h source file, line 156.
This function sets the multiplier of the alpha channel.
Parameter list:
- upipe: description structure of the pipe
- alpha: multiplier of the alpha channel
The return value is an error code
This function is declared in upipe-modules/upipe_blit.h source file, line 183.
This function sets the method for alpha blending for this subpipe.
Parameter list:
- upipe: description structure of the pipe
- threshold: method for alpha blending ()
The return value is an error code
int upipe_blit_sub_set_rect(struct upipe *upipe, uint64_t loffset, uint64_t roffset, uint64_t toffset, uint64_t boffset)
This function is declared in upipe-modules/upipe_blit.h source file, line 129.
This function sets the offsets (from the respective borders of the frame) of the rectangle onto which the input of the subpipe will be blitted.
Parameter list:
- upipe: description structure of the pipe
- loffset: offset from the left border
- roffset: offset from the right border
- toffset: offset from the top border
- boffset: offset from the bottom border
The return value is an error code
This function is declared in upipe-modules/upipe_blit.h source file, line 209.
This function sets the z-index for this subpipe.
Parameter list:
- upipe: description structure of the pipe
- z_index: z-index
The return value is an error code