Passes Property

Summary

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

Syntax

Java

Objective-C

WinRT C#

C++

public int Passes { get; set; }

Public Property Passes As Integer

public int Passes {get; set;}

@property (nonatomic, assign) NSInteger passes

public int getPasses() 
public void setPasses(int value)

 <br/>get_Passes();<br/>set_Passes(value);<br/>Object.defineProperty('Passes');

public: 
property int Passes { 
   int get(); 
   void set (    int ); 
}

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.

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).

Example

For an example, refer to CodecsOptions.

Requirements

Target Platforms