MuPDFCore 1.8.0
Multiplatform .NET bindings for MuPDF
Loading...
Searching...
No Matches
MuPDFCore.MuPDFContext Class Reference

A wrapper around a MuPDF context object, which contains the exception stack and the resource cache store. More...

Inheritance diagram for MuPDFCore.MuPDFContext:

Public Member Functions

 MuPDFContext (uint storeSize=256<< 20)
 Create a new MuPDFContext instance with the specified cache store size. More...
 
void ClearStore ()
 Evict all items from the resource cache store (freeing the memory where they were held). More...
 
void ShrinkStore (double fraction)
 Evict items from the resource cache store (freeing the memory where they were held) until the the size of the store drops to the specified fraction of the current size. More...
 
void Dispose ()
 

Properties

long StoreSize [get]
 The current size in bytes of the resource cache store. Read-only. More...
 
long StoreMaxSize [get]
 The maximum size in bytes of the resource cache store. Read-only. More...
 
int AntiAliasing [set]
 Sets the current anti-aliasing level. Changing this value will affect both the TextAntiAliasing and the GraphicsAntiAliasing. More...
 
int TextAntiAliasing [get, set]
 Gets or sets the current text anti-aliasing level. More...
 
int GraphicsAntiAliasing [get, set]
 Gets or sets the current graphics anti-aliasing level. More...
 

Detailed Description

A wrapper around a MuPDF context object, which contains the exception stack and the resource cache store.

Definition at line 25 of file MuPDFContext.cs.

Constructor & Destructor Documentation

◆ MuPDFContext()

MuPDFCore.MuPDFContext.MuPDFContext ( uint  storeSize = 256 << 20)

Create a new MuPDFContext instance with the specified cache store size.

Parameters
storeSizeThe maximum size in bytes of the resource cache store. The default value is 256 MiB.

Definition at line 120 of file MuPDFContext.cs.

Member Function Documentation

◆ ClearStore()

void MuPDFCore.MuPDFContext.ClearStore ( )

Evict all items from the resource cache store (freeing the memory where they were held).

Definition at line 149 of file MuPDFContext.cs.

◆ Dispose()

void MuPDFCore.MuPDFContext.Dispose ( )

Definition at line 194 of file MuPDFContext.cs.

◆ ShrinkStore()

void MuPDFCore.MuPDFContext.ShrinkStore ( double  fraction)

Evict items from the resource cache store (freeing the memory where they were held) until the the size of the store drops to the specified fraction of the current size.

Parameters
fractionThe fraction of the current size that constitutes the target size of the store. If this is <= 0, the cache is cleared. If this is >= 1, nothing happens.

Definition at line 158 of file MuPDFContext.cs.

Property Documentation

◆ AntiAliasing

int MuPDFCore.MuPDFContext.AntiAliasing
set

Sets the current anti-aliasing level. Changing this value will affect both the TextAntiAliasing and the GraphicsAntiAliasing.

Definition at line 58 of file MuPDFContext.cs.

◆ GraphicsAntiAliasing

int MuPDFCore.MuPDFContext.GraphicsAntiAliasing
getset

Gets or sets the current graphics anti-aliasing level.

Definition at line 96 of file MuPDFContext.cs.

◆ StoreMaxSize

long MuPDFCore.MuPDFContext.StoreMaxSize
get

The maximum size in bytes of the resource cache store. Read-only.

Definition at line 46 of file MuPDFContext.cs.

◆ StoreSize

long MuPDFCore.MuPDFContext.StoreSize
get

The current size in bytes of the resource cache store. Read-only.

Definition at line 35 of file MuPDFContext.cs.

◆ TextAntiAliasing

int MuPDFCore.MuPDFContext.TextAntiAliasing
getset

Gets or sets the current text anti-aliasing level.

Definition at line 74 of file MuPDFContext.cs.


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