LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
Passes Property
See Also 
Leadtools.Codecs Namespace > CodecsLoadOptions Class : Passes Property



Gets or sets the number of passes (scans through the image) when loading a progressive image (JPEG mainly).

Syntax

Visual Basic (Declaration) 
Public Property Passes As Integer
Visual Basic (Usage)Copy Code
Dim instance As CodecsLoadOptions
Dim value As Integer
 
instance.Passes = value
 
value = instance.Passes
C# 
public int Passes {get; set;}
C++/CLI 
public:
property int Passes {
   int get();
   void set (    int value);
}

Property Value

The number of passes (scans through the image) when loading a progressive image.

Value Meaning
Any positive number. Load a progressive file showing at most the specified number of passes.
0 Load the file in one pass.
-1 Load a progressive file showing only significant scans.
-2 Load a progressive file showing all the scans.

Example

For an example, refer to CodecsOptions.

Remarks

This value is also used when loading JBIG files to determine the number of resolutions to load to create a progressive load effect.

This property controls the number of times the RasterCodecs.LoadImage event can be called for a particular row. If you do not use the RasterCodecs.LoadImage event, this value is ignored.The RasterCodecs.LoadImage event can be used to implement a paint while load feature. For progressive files, the event is called several times for the same image row. The quality of the row is improved with every call. The improvements in some passes do not have visual improvements, so it is recommended you show only the significant scans (-1).

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also