API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IGRAPHICS_SETCLIP()

Brew Release
Brew MP 1.0.2
See Also
IGraphics IGRAPHICS_GetClip()
Description
This function sets the clipping area. Graphics contents will be displayed on the screen only if they are within the clipping area. If the pointer pShape is NULL, it resets the clipping region the window.
Params
pIGraphics
[]:
Pointer to the IGraphics interface object.
pShape
[]:
Pointer to the clipping shape.
nFlag
[]:
Bitmap flags.
Interface
  • IGRAPHICS
Prototype
  • boolean IGRAPHICS_SetClip(IGraphics *pIGraphics, AEEClip *pShape, uint8 nFlag);
    
Return
  • TRUE: The clipping area was set successfully. FALSE: Otherwise.
Side Effect
  • None
Comments
If nFlag is set to AEE_GRAPHICS_FRAME, it draws the frame using the current foreground color and the paint mode, while setting the clipping region. If nFlag is set to AEE_GRAPHICS_CLEAR, it clears the interior of of the clipping region while setting it. If nFlag is set to AEE_GRAPHICS_FILL, it fills the interior using the current fill color and the current paint mode, while setting the clipping region.