VectSharp  2.2.1
A light library for C# vector graphics
VectSharp.SVG.SVGContextInterpreter.FilterOption Class Reference

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

Public Types

enum  FilterOperations {
  FilterOperations.RasteriseAll, FilterOperations.RasteriseIfNecessary, FilterOperations.NeverRasteriseAndIgnore, FilterOperations.NeverRasteriseAndSkip,
  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.RasteriseIfNecessary, 1, true)
 The default options for image filter rasterisation. More...
 

Properties

FilterOperations Operation = FilterOperations.RasteriseIfNecessary [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 1656 of file SVGContext.cs.

Member Enumeration Documentation

◆ FilterOperations

Defines whether image filters should be rasterised or not.

Enumerator
RasteriseAll 

Image filters will always be rasterised.

RasteriseIfNecessary 

Image filters will only be rasterised if they are not supported natively by the output file format.

NeverRasteriseAndIgnore 

Image filters will never be rasterised; for filters that are not supported, the filter will be ignored.

NeverRasteriseAndSkip 

Image filters will never be rasterised; if an image should be drawn with an unsupported filter, the image will not be drawn at all.

IgnoreAll 

All image filters (supported and unsupported) will be ignored.

SkipAll 

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

Definition at line 1661 of file SVGContext.cs.

Constructor & Destructor Documentation

◆ FilterOption()

VectSharp.SVG.SVGContextInterpreter.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 1720 of file SVGContext.cs.

Member Data Documentation

◆ Default

FilterOption VectSharp.SVG.SVGContextInterpreter.FilterOption.Default = new FilterOption(FilterOperations.RasteriseIfNecessary, 1, true)
static

The default options for image filter rasterisation.

Definition at line 1712 of file SVGContext.cs.

Property Documentation

◆ Operation

FilterOperations VectSharp.SVG.SVGContextInterpreter.FilterOption.Operation = FilterOperations.RasteriseIfNecessary
get

Defines whether image filters should be rasterised or not.

Definition at line 1697 of file SVGContext.cs.

◆ RasterisationResolution

double VectSharp.SVG.SVGContextInterpreter.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 1702 of file SVGContext.cs.

◆ RasterisationResolutionRelative

bool VectSharp.SVG.SVGContextInterpreter.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 1707 of file SVGContext.cs.


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