VectSharp  2.2.1
A light library for C# vector graphics
VectSharp.PDF.PDFContextInterpreter.FilterOption Class Reference

Determines how and whether image filters are rasterised. More...

Public Types

enum  FilterOperations { FilterOperations.RasteriseAll, FilterOperations.IgnoreAll, FilterOperations.SkipAll }
 Defines whether image filters should be rasterised or not. More...
 

Public Member Functions

 FilterOption (FilterOperations operation, double rasterisationResolution, bool rasterisationResolutionRelative)
 Create a new FilterOption object. More...
 

Static Public Attributes

static FilterOption Default = new FilterOption(FilterOperations.RasteriseAll, 1, true)
 The default options for image filter rasterisation. More...
 

Properties

FilterOperations Operation = FilterOperations.RasteriseAll [get]
 Defines whether image filters should be rasterised or not. More...
 
double RasterisationResolution = 1 [get]
 The resolution that will be used to rasterise image filters. Depending on the value of RasterisationResolutionRelative, this can either be an absolute resolution (i.e. a size in pixel), or a scale factor that is applied to the image size in graphics units. More...
 
bool RasterisationResolutionRelative = true [get]
 Determines whether the value of RasterisationResolution is absolute (i.e. a size in pixel), or relative (i.e. a scale factor that is applied to the image size in graphics units). More...
 

Detailed Description

Determines how and whether image filters are rasterised.

Definition at line 1139 of file PDFContext.cs.

Member Enumeration Documentation

◆ FilterOperations

Defines whether image filters should be rasterised or not.

Enumerator
RasteriseAll 

Image filters will always be rasterised.

IgnoreAll 

All image filters will be ignored.

SkipAll 

All the images that should be drawn with a filter will be ignored.

Definition at line 1144 of file PDFContext.cs.

Constructor & Destructor Documentation

◆ FilterOption()

VectSharp.PDF.PDFContextInterpreter.FilterOption.FilterOption ( FilterOperations  operation,
double  rasterisationResolution,
bool  rasterisationResolutionRelative 
)

Create a new FilterOption object.

Parameters
operationDefines whether image filters should be rasterised or not.
rasterisationResolutionThe resolution that will be used to rasterise image filters. Depending on the value of RasterisationResolutionRelative, this can either be an absolute resolution (i.e. a size in pixel), or a scale factor that is applied to the image size in graphics units.
rasterisationResolutionRelativeDetermines whether the value of RasterisationResolution is absolute (i.e. a size in pixel), or relative (i.e. a scale factor that is applied to the image size in graphics units).

Definition at line 1188 of file PDFContext.cs.

Member Data Documentation

◆ Default

FilterOption VectSharp.PDF.PDFContextInterpreter.FilterOption.Default = new FilterOption(FilterOperations.RasteriseAll, 1, true)
static

The default options for image filter rasterisation.

Definition at line 1180 of file PDFContext.cs.

Property Documentation

◆ Operation

FilterOperations VectSharp.PDF.PDFContextInterpreter.FilterOption.Operation = FilterOperations.RasteriseAll
get

Defines whether image filters should be rasterised or not.

Definition at line 1165 of file PDFContext.cs.

◆ RasterisationResolution

double VectSharp.PDF.PDFContextInterpreter.FilterOption.RasterisationResolution = 1
get

The resolution that will be used to rasterise image filters. Depending on the value of RasterisationResolutionRelative, this can either be an absolute resolution (i.e. a size in pixel), or a scale factor that is applied to the image size in graphics units.

Definition at line 1170 of file PDFContext.cs.

◆ RasterisationResolutionRelative

bool VectSharp.PDF.PDFContextInterpreter.FilterOption.RasterisationResolutionRelative = true
get

Determines whether the value of RasterisationResolution is absolute (i.e. a size in pixel), or relative (i.e. a scale factor that is applied to the image size in graphics units).

Definition at line 1175 of file PDFContext.cs.


The documentation for this class was generated from the following file: