BitDepth Property (Device)

In This Topic

Gets or sets the bit depth of images for current scan session.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration

Public Property BitDepth As Integer

public int BitDepth { get; set; }

public: __property int get_BitDepth();
public: __property void set_BitDepth(
   int value
);

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

Exceptions

Exception	Description
TwainInvalidStateException	Thrown if device is in wrong state.
TwainDeviceCapabilityException	Thrown if device does not support capability.
DebuggerException	Thrown if the .NET debugger is used and the function evaluation requires all threads to run.

Remarks

Call this property only when device is opened (State == DeviceState.Opened).

Supported values of bit depths can be received by the GetSupportedBitDepths method.

Example

This C#/VB.NET code shows how to acquire 4-bpp palette images from the device.

VB.NET


Public Sub ScanPaletteImage(device As Vintasoft.Twain.Device)
        device.ShowUI = False
        device.DisableAfterAcquire = True

        device.Open()
        device.PixelType = Vintasoft.Twain.PixelType.Palette
        device.BitDepth = 4
        device.UnitOfMeasure = Vintasoft.Twain.UnitOfMeasure.Inches
        device.Resolution = New Vintasoft.Twain.Resolution(200F, 200F)

        device.Acquire()
End Sub


public void ScanPaletteImage(Vintasoft.Twain.Device device)
{
    device.ShowUI = false;
    device.DisableAfterAcquire = true;

    device.Open();
    device.PixelType = Vintasoft.Twain.PixelType.Palette;
    device.BitDepth = 4;
    device.UnitOfMeasure = Vintasoft.Twain.UnitOfMeasure.Inches;
    device.Resolution = new Vintasoft.Twain.Resolution(200f, 200f);

    device.Acquire();
}

Requirements

Target Platforms: .NET 9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

Device Class
Device Members

GetSupportedBitDepths
Open
PixelType

Send Feedback