PDFDraw.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2026 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFPDFDraw
#define PDFTRON_H_CPPPDFPDFDraw

#include <PDF/PDFRasterizer.h>
#include <C/PDF/TRN_PDFDraw.h>

#ifdef SWIG
#include <PDF/Callback.h>
#endif

// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
#if defined(_WIN32)
  // A forward declaration for GDI+ Bitmap-s which can be directly created using PDFDraw::GetBitmap() method.
  namespace Gdiplus { class Bitmap; };
#endif
#endif
// @endcond




namespace pdftron { 
    namespace PDF {


//return type for PDFDraw::GetBitmap
class BitmapInfo
{
    std::vector<unsigned char> buf;
      
public:
    BitmapInfo(int w, int h, int s, double d, char* b) {
        width = w;
        height = h;
        stride = s;
        dpi = d;
        if (h * s > 0) {
            buf.resize((std::vector<unsigned char>::size_type)(h * s));
            if (b)
            {
                memcpy(&buf[0], b, (size_t)(h * s));
            }
        }
    }
    int width;
    int height;
    int stride;
    double dpi;

    //copy constructor
    BitmapInfo(const BitmapInfo& b) {
        width = b.width;
        height = b.height;
        stride = b.stride;
        dpi = b.dpi;
        std::vector<unsigned char> temp(b.GetBuffer());
        buf.swap(temp);
    }
      
    std::vector<unsigned char> GetBuffer() const {
        return buf;
    }
};

class Separation;

class PDFDraw
{
public: 

    PDFDraw(double dpi = 92);
    ~PDFDraw();

    void SetRasterizerType (PDFRasterizer::Type type);

    void SetDPI(double dpi);

    void SetImageSize(int width, int height, bool preserve_aspect_ratio = true);

    void SetPageBox(Page::Box region);

    void SetClipRect(Rect clip_rect);

    void SetFlipYAxis(bool flip_y);

    void SetRotate(Page::Rotate r);

    void SetDrawAnnotations(bool render_annots);

    void SetHighlightFields(bool highlight_fields);

    void SetDrawUIElements(bool draw_ui_elements);

    void SetAntiAliasing(bool enable_aa);

    void SetPathHinting(bool enable_hinting);

    void SetThinLineAdjustment(bool pixel_grid_fit, bool stroke_adjust);

    void SetThinLineScaling(double scaling);

    void SetImageSmoothing(bool smoothing_enabled = true, bool hq_image_resampling = false);

    void SetCaching(bool enabled = true);   

    void SetGamma(double exp);

    void SetOCGContext(OCG::Context* ctx);
        
    void SetPrintMode(bool is_printing);

    void SetDefaultPageColor(UInt8 r, UInt8 g, UInt8 b);

    void SetPageTransparent(bool is_transparent);

    void SetOverprint(PDFRasterizer::OverprintPreviewMode op);

    void Export(Page page, const UString& filename, const char* format = "PNG", SDF::Obj encoder_params = 0);

     void Export(Page page, Filters::Filter& stream, const char* format = "PNG", SDF::Obj encoder_params = 0);

    #ifdef __DOTNET
    System::Drawing::Bitmap* GetBitmap(Page page);
    #endif

#if defined(_WIN32) && !defined(__WINRT__)
    void DrawInRect(Page& page, void* hdc, const Rect& rect);
#endif

    enum PixelFormat {
        e_rgba,
        e_bgra,
        e_rgb,
        e_bgr,
        e_gray, 
        e_gray_alpha,
        e_cmyk
    };

    const BitmapInfo GetBitmap(Page page, PixelFormat pix_fmt = e_bgra, bool demult = false);

    std::vector<Separation> GetSeparationBitmaps(Page page);

#ifndef SWIG

    const UChar* GetBitmap(Page page, int& out_width, int& out_height, int& out_stride, double& out_dpi, 
        PixelFormat pix_fmt = e_bgra, bool demult = false);
#endif

#ifdef SWIG
    void SetErrorReportProc(Callback* instance);
#else
    void SetErrorReportProc(PDFRasterizer::ErrorReportProc error_proc, void* data);
#endif

    void SetColorPostProcessMode(PDFRasterizer::ColorPostProcessMode mode);

     void Destroy();

// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    TRN_PDFDraw mp_draw;
#endif
private:
    // PDFDraw should not be copied
    PDFDraw(const PDFDraw& other);
    PDFDraw& operator= (const PDFDraw&);
// @endcond
};


#include <Impl/PDFDraw.inl>


    };  // namespace PDF
};  // namespace pdftron

#endif // PDFTRON_H_CPPPDFPDFDraw