WatermarkOptions

Configurations of the watermark image.

struct WatermarkOptions {
  bool visibleInPreview;
  Rectangle positionInLandscapeMode;
  Rectangle positionInPortraitMode;
  WatermarkRatio watermarkRatio;
  WATERMARK_FIT_MODE mode;
  WatermarkOptions()
    : visibleInPreview(false),
      positionInLandscapeMode(0, 0, 0, 0),
      positionInPortraitMode(0, 0, 0, 0),
      mode(FIT_MODE_COVER_POSITION) {}
};

Attributes

visibleInPreview
Is the watermark visible in the local preview view?
  • true: (Default) The watermark is visible in the local preview view.
  • false: The watermark is not visible in the local preview view.
positionInLandscapeMode
When the adaptation mode of the watermark is FIT_MODE_COVER_POSITION, it is used to set the area of the watermark image in landscape mode. See Rectangle.
positionInPortraitMode
When the adaptation mode of the watermark is FIT_MODE_COVER_POSITION, it is used to set the area of the watermark image in portrait mode. See Rectangle.
watermarkRatio
When the watermark adaptation mode is FIT_MODE_USE_IMAGE_RATIO, this parameter is used to set the watermark coordinates. See WatermarkRatio.
mode
The adaptation mode of the watermark. See WATERMARK_FIT_MODE.