PictureEffects Xojo Plugin |

# PageCurlModule.PageCurl Method

Use the PageCurl function to do a "PageCurl" effect where it appears as a corner of the picture is rolled up.

PageCurl(
src as Picture,
cornerNumber as Integer,
params as PageCurlParams) as Picture

#### Parameters

src
  The source picture to work with (has to be 32 bit picture).
cornerNumber
  0: Top left corner.
  1: Top right corner.
  2: Bottom left corner.
  3: Bottom right corner.
  Anything else: Same as 0.
params
  Use this parameter to pass more detailed information to the PageCurl function.
  This parameter may be set to nil, if more detailed control is not wanted.
  Features available with the PageCurlParams class:
  - Opacity of the curl.
  - Horizontal curl.
  - Selection (Definition of where in the image the curl should be created).
  - Progress to set a progress proc for the PageCurl function.
  - CurlColor to set the color of the curl.
  - BackColor to set the color of the background.
  - UseOriginalBackground to make it appear as if another exactly the same picture is under the current one, like in a card deck.
  - BackGroundPicture to make it appear as if another different picture is under current picture.
    See more in the documentation about the PageCurlParams Class.

#### Returns

Picture
  If the filter was successful: A reference to the modified picture.
  If the src picture was not 32 bits then a nil will be returned.

#### Remarks

#### Supported Platforms:

- MacOS X Carbon
- MacOS X Cocoa 32 bit
- MacOS X Cocoa 64 bit
- Windows 32 bit
- Windows 64 bit
- Linux 32 bit
- Linux 64 bit
- Linux ARM

  #### See Also

  PageCurlModule Module