BitsPerPixel Property

Summary

Gets or sets the final bits per pixel of the loaded RasterImage.

Syntax

Objective-C

C++/CLI

Java

Python

public int BitsPerPixel {get; set;}

@property (nonatomic, assign) NSInteger bitsPerPixel;

public int getBitsPerPixel() 
public void setBitsPerPixel(int bitsPerPixel)

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

BitsPerPixel # get and set (CodecsDocLoadOptions)

Property Value

One of the supported LEADTOOLS bits per pixel values. The default value is 24.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
 
using Leadtools.ImageProcessing.Core; 
using Leadtools.Pdf; 
 
public void CodecsDocLoadOptionsExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "test.doc"); 
 
   // Enable using the RasterizeDocumentOptions 
   CodecsRasterizeDocumentLoadOptions rasterizeDocumentLoadOptions = codecs.Options.RasterizeDocument.Load; 
   // Fit the document at 8.5 by 11 inches at 96 DPI keeping the aspect ratio 
   rasterizeDocumentLoadOptions.SizeMode = CodecsRasterizeDocumentSizeMode.Fit; 
   rasterizeDocumentLoadOptions.PageWidth = 8.5; 
   rasterizeDocumentLoadOptions.PageHeight = 11; 
   rasterizeDocumentLoadOptions.Unit = CodecsRasterizeDocumentUnit.Inch; 
   rasterizeDocumentLoadOptions.XResolution = 300; 
   rasterizeDocumentLoadOptions.YResolution = 300; 
 
   // Load each page at 1-bits/pixel 
   codecs.Options.Doc.Load.BitsPerPixel = 1; // CodecsDocLoadOptions & CodecsDocOptions references 
 
   // Load the source file 
   using (RasterImage image = codecs.Load(srcFileName)) 
   { 
      // Show the image information 
      Debug.WriteLine("Image has {0} pages", image.PageCount); 
      Debug.WriteLine("Image size: {0} by {1} pixels at {2} by {3} DPI", 
         image.ImageWidth, image.ImageHeight, image.XResolution, image.YResolution); 
   } 
 
   // Clean up 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
import java.net.URI; 
import java.net.URISyntaxException; 
import java.nio.file.Paths; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.imageprocessing.core.MinMaxBitsCommand; 
 
 
public void codecsDocLoadOptionsExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   RasterCodecs codecs = new RasterCodecs(); 
   String srcFileName = combine(LEAD_VARS_IMAGES_DIR, "Example.doc"); 
 
   // Enable using the RasterizeDocumentOptions 
   CodecsRasterizeDocumentLoadOptions rasterizeDocumentLoadOptions = codecs.getOptions().getRasterizeDocument().getLoad(); 
   // Fit the document at 8.5 by 11 inches at 96 DPI keeping the aspect ratio 
   rasterizeDocumentLoadOptions.setSizeMode(CodecsRasterizeDocumentSizeMode.FIT); 
   rasterizeDocumentLoadOptions.setPageWidth(8.5); 
   rasterizeDocumentLoadOptions.setPageHeight(11); 
   rasterizeDocumentLoadOptions.setUnit(CodecsRasterizeDocumentUnit.INCH); 
   rasterizeDocumentLoadOptions.setXResolution(300); 
   rasterizeDocumentLoadOptions.setYResolution(300); 
 
   // Load each page at 1-bits/pixel 
   codecs.getOptions().getDoc().getLoad().setBitsPerPixel(1); // CodecsDocLoadOptions & CodecsDocOptions references 
 
   // Load the source file 
   RasterImage image = codecs.load(srcFileName); 
 
   String outputFileName = combine(LEAD_VARS_IMAGES_DIR, "Result.jpg"); 
   codecs.save(image, outputFileName, RasterImageFormat.JPEG, 0); 
 
   assertTrue("File unsuccessfully saved to " + outputFileName, (new File(outputFileName)).exists()); 
   System.out.printf("File successfully saved to %s%n", outputFileName); 
 
   // Show the image information 
   System.out.printf("Image has %1d pages", image.getPageCount()); 
   System.out.printf("Image size: %1d by %2d pixels at %3d by %4d DPI", 
         image.getImageWidth(), image.getImageHeight(), image.getXResolution(), image.getYResolution()); 
   image = null; 
 
   // Clean up 
   codecs.dispose(); 
}

Requirements

Target Platforms

Reference

CodecsDocLoadOptions Class

CodecsDocLoadOptions Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies