blob: 6fef0896dfb8c7980eb809f91dc58faf806dcb00 [file] [log] [blame]
// Copyright 2016 The PDFium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
#ifndef CORE_FXGE_RENDERDEVICEDRIVER_IFACE_H_
#define CORE_FXGE_RENDERDEVICEDRIVER_IFACE_H_
#include <stdint.h>
#include <memory>
#include "core/fxcrt/fx_coordinates.h"
#include "core/fxcrt/retain_ptr.h"
#include "core/fxge/dib/fx_dib.h"
#include "third_party/base/containers/span.h"
class CFX_DIBBase;
class CFX_DIBitmap;
class CFX_Font;
class CFX_GraphStateData;
class CFX_ImageRenderer;
class CFX_Matrix;
class CFX_Path;
class CPDF_ShadingPattern;
class PauseIndicatorIface;
class TextCharPos;
struct CFX_FillRenderOptions;
struct CFX_TextRenderOptions;
struct FX_RECT;
enum class DeviceType : bool {
kDisplay,
kPrinter,
};
class RenderDeviceDriverIface {
public:
virtual ~RenderDeviceDriverIface();
virtual DeviceType GetDeviceType() const = 0;
virtual int GetDeviceCaps(int caps_id) const = 0;
virtual void SaveState() = 0;
virtual void RestoreState(bool bKeepSaved) = 0;
virtual void SetBaseClip(const FX_RECT& rect);
virtual bool SetClip_PathFill(const CFX_Path& path,
const CFX_Matrix* pObject2Device,
const CFX_FillRenderOptions& fill_options) = 0;
virtual bool SetClip_PathStroke(const CFX_Path& path,
const CFX_Matrix* pObject2Device,
const CFX_GraphStateData* pGraphState);
virtual bool DrawPath(const CFX_Path& path,
const CFX_Matrix* pObject2Device,
const CFX_GraphStateData* pGraphState,
uint32_t fill_color,
uint32_t stroke_color,
const CFX_FillRenderOptions& fill_options,
BlendMode blend_type) = 0;
virtual bool FillRectWithBlend(const FX_RECT& rect,
uint32_t fill_color,
BlendMode blend_type);
virtual bool DrawCosmeticLine(const CFX_PointF& ptMoveTo,
const CFX_PointF& ptLineTo,
uint32_t color,
BlendMode blend_type);
virtual bool GetClipBox(FX_RECT* pRect) = 0;
virtual bool GetDIBits(const RetainPtr<CFX_DIBitmap>& pBitmap,
int left,
int top);
virtual RetainPtr<CFX_DIBitmap> GetBackDrop();
virtual bool SetDIBits(RetainPtr<const CFX_DIBBase> bitmap,
uint32_t color,
const FX_RECT& src_rect,
int dest_left,
int dest_top,
BlendMode blend_type) = 0;
virtual bool StretchDIBits(RetainPtr<const CFX_DIBBase> bitmap,
uint32_t color,
int dest_left,
int dest_top,
int dest_width,
int dest_height,
const FX_RECT* pClipRect,
const FXDIB_ResampleOptions& options,
BlendMode blend_type) = 0;
virtual bool StartDIBits(RetainPtr<const CFX_DIBBase> bitmap,
float alpha,
uint32_t color,
const CFX_Matrix& matrix,
const FXDIB_ResampleOptions& options,
std::unique_ptr<CFX_ImageRenderer>* handle,
BlendMode blend_type) = 0;
virtual bool ContinueDIBits(CFX_ImageRenderer* handle,
PauseIndicatorIface* pPause);
virtual bool DrawDeviceText(pdfium::span<const TextCharPos> pCharPos,
CFX_Font* pFont,
const CFX_Matrix& mtObject2Device,
float font_size,
uint32_t color,
const CFX_TextRenderOptions& options);
virtual int GetDriverType() const;
virtual bool DrawShading(const CPDF_ShadingPattern* pPattern,
const CFX_Matrix* pMatrix,
const FX_RECT& clip_rect,
int alpha,
bool bAlphaMode);
#if defined(PDF_USE_SKIA)
virtual bool SetBitsWithMask(RetainPtr<const CFX_DIBBase> bitmap,
RetainPtr<const CFX_DIBBase> mask,
int left,
int top,
float alpha,
BlendMode blend_type);
virtual void SetGroupKnockout(bool group_knockout);
// For `CFX_SkiaDeviceDriver` only:
// Syncs the current rendering result from the internal buffer to the output
// bitmap if such internal buffer exists.
virtual bool SyncInternalBitmaps();
#endif
// Multiplies the device by a constant alpha, returning `true` on success.
// Implementations CHECK the following conditions:
// - `this` is bitmap-based and `this` is not of a mask format.
//
// The backing bitmap for `this` will be converted to format
// `FXDIB_Format::kArgb` on success when `alpha` is not 1.
virtual bool MultiplyAlpha(float alpha) = 0;
// Multiplies the device by an alpha mask, returning `true` on success.
// Implementations CHECK the following conditions:
// - `this` is bitmap-based and of format `FXDIB_Format::kArgb` or
// `FXDIB_Format::kRgb32`.
// - `mask` must be of format `FXDIB_Format::k8bppMask`.
// - `mask` must have the same dimensions as `this`.
//
// The backing bitmap for `this` will be converted to format
// `FXDIB_Format::kArgb` on success.
virtual bool MultiplyAlphaMask(RetainPtr<const CFX_DIBitmap> mask) = 0;
};
#endif // CORE_FXGE_RENDERDEVICEDRIVER_IFACE_H_