Module Documentation
FM4, S6E2DH/S6E2DF/S6E2D5/S6E2D3 Series, 32-Bit Microcontroller, Graphic Driver User Manual, Doc. No. 002-04387 Rev. *A
122
MML_GDC_PE_SURF_ATTR_USE_CLIPPING
Define whether or not the surface coordinates given by mmlGdcPeActiveArea are used as clip coordinates
while reading (SRC, DST, MASK) or writing (STORE) the surface. If USE_CLIPPING is disabled the ActiveArea
coordinates are used for the target blit bounding box calculation only. If USE_CLIPPING is enabled the surface
will be used like a smaller bitmap.
Note:
While using clipping for source surfaces, the attribute MML_GDC_PE_SURF_ATTR_TILE_MODE must set to
MML_GDC_PE_TILE_FILL_ZERO.
The bounding box defined by mmlGdcPeActiveArea() will be always used as clipping box if USE_CLIPPING is
enabled. (Independent of the mmlGdcPeSelectArea() settings.)
MM_FALSE (default): disable CLIP feature.
MM_TRUE: enable clip feature.
11.6.5 Function Documentation
11.6.5.1 MML_GDC_PE_API MM_ERROR mmlGdcPeActiveArea(MML_GDC_PE_CONTEXT pectx,
MM_U32 target, MM_S32 x, MM_S32 y, MM_U32 w, MM_U32 h)
mmlGdcPeActiveArea defines the processing area for the surface that is bound to the specified target. See also
mmlGdcPeSelectArea and MML_GDC_PE_SURF_ATTR_USE_CLIPPING.
The area is defined by lower left coordinate, width and height. The lower left coordinate is inside of processing area.
The upper right coordinate (x+w, y+h) is outside of processing area.
Parameters must be x < x+w and y < y+h.If x or y is equal to 4096, function returns
MML_ERR_GDC_PE_INVALID_PARAMETER. If w and h are equal to 0, active area is disabled. If x and y are
negative, the color value is defined by mmlGdcPeSurfAttribute and MML_GDC_PE_SURF_ATTR_TILE_MODE. If
pectx is equal to NULL, mmlGdcPeActiveArea is terminated without any operation.
Note:
Blit operations with a non default mmlGdcPeActiveArea setting may fail and report an error if buffers are involved
with a bit per pixel size different to multiple of 8bit or YUV color format.
Parameters
in,out
pectx
Pixel Engine context (!=NULL).
in
target
[in] Setting target. It is a single or OR combined value of:
MML_GDC_PE_SRC
MML_GDC_PE_DST
MML_GDC_PE_STORE
MML_GDC_PE_MASK
in
x
Left start coordinate of the active area (-4095 - 4096).
in
y
Lower (or upper see MML_GDC_PE_ATTR_ZERO_POINT) start coordinate of the active area
(-4095 - 4096).
in
w
Width of active area (0 - 4096).
in
h
Height of active area (0 - 4096).
Return values
MML_OK
On success. Otherwise the related error code.