
Module Documentation
FM4, S6E2DH/S6E2DF/S6E2D5/S6E2D3 Series, 32-Bit Microcontroller, Graphic Driver User Manual, Doc. No. 002-04387 Rev. *A
89
Parameters
in
surf
The surface object.
in
uWidth
The width in pixels of the image.
in
uHeight
The height in pixels of the image.
in
eFormat
The format of the image. The format defines the fields BitPerPixel, ColorBits,
ColorShift, Color format.
in
pBufferAddress
The memory address of the image. The buffer starts with the upper left pixel.
in
uRleWords
Number of 32-bit words that are required to decode the run length encoded source
buffer. Zero indicates an uncompressed buffer.
Return values
MML_OK
On success.
MML_ERR_GDC_SURF_INVALID_SURFACE
If NULL pointer is given for surf.
MML_ERR_GDC_SURF_INVALID_FORMAT
If illegal value is given for eFormat.
MML_ERR_GDC_SURF_INVALID_PARAMETER
If surface size is out of range, see
MML_GDC_SURFACE_MAX_WIDTH and
MML_GDC_SURFACE_MAX_HEIGHT.
11.4.5.2 MM_ERROR mmlGdcSmAssignClut(MML_GDC_SURFACE surf, MML_GDC_SURF_CLM
eMode, MM_U32 uCount, MML_GDC_SURF_CLF eFormat, void
∗
pBufferAddress)
Assign a color lookup table to a surface. It points to a VRAM memory address owned by the application. The
application must ensure that the memory is available as long as the surface is still in use and that the memory block
is large enough with respect to the width, height and format parameters of the surface.
Note:
uCount = 0 or pBufferAddress = 0 set the CLUT in neutral mode, input data is bypassed to the output.
Parameters
in
surf
The surface object getting this new property.
in
eMode
Defines the operation mode for the CLUT.
in
uCount
Number of table entries to be written.
in
eFormat
Format of the table entries.
in
pBufferAddress
The address of the color index buffer.
Return values
MML_OK
On success.
MML_ERR_GDC_SURF_INVALID_SURFACE
If NULL pointer is given for surf.
MML_ERR_GDC_SURF_INVALID_PARAMETER
If illegal value is given for eMode.
MML_ERR_GDC_SURF_INVALID_FORMAT
If illegal value is given for eFormat.