DiskMemory Property

Summary

Gets or sets a value indicating whether to use disk memory when loading an image.

Syntax

Objective-C

C++

Java

public bool DiskMemory { get; set; }

Public Property DiskMemory As Boolean

@property (nonatomic, assign) BOOL diskMemory

public boolean getDiskMemory() 
public void setDiskMemory(boolean value)

public: 
property bool DiskMemory { 
   bool get(); 
   void set (    bool ); 
}

Property Value

true to load the image using disk memory; false otherwise.

Remarks

When the value of this property is true, the image is stored in disk and not in conventional memory.

Example

using Leadtools; 
using Leadtools.Codecs; 
 
public void DiskMemoryExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
   string fileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
   // first, load the image using the default 
   RasterImage image = codecs.Load(fileName); 
 
   // make sure the image uses conventional memory 
   if (image.IsConventionalMemory) 
      Console.WriteLine("This image uses conventional memory"); 
   else 
      Console.WriteLine("This should not happen!!"); 
 
   image.Dispose(); 
 
   // now, load the same image this time using disk memory 
   codecs.Options.Load.DiskMemory = true; 
   image = codecs.Load(fileName, 0, CodecsLoadByteOrder.BgrOrGray, 1, 1); 
 
   // make sure the image uses unmanaged memory 
   if (image.IsDiskMemory) 
      Console.WriteLine("This image uses disk memory"); 
   else 
      Console.WriteLine("This should not happen!!"); 
 
   // Clean up 
   image.Dispose(); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
 
Public Sub DiskMemoryExample() 
   Dim codecs As RasterCodecs = New RasterCodecs() 
   Dim fileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp") 
   ' first, load the image using the default 
   Dim image As RasterImage = codecs.Load(fileName) 
 
   ' make sure the image uses conventional memory 
   If image.IsConventionalMemory Then 
      Console.WriteLine("This image uses conventional memory") 
   Else 
      Console.WriteLine("This should not happen!!") 
   End If 
 
   image.Dispose() 
 
   ' now, load the same image this time using disk memory 
   codecs.Options.Load.DiskMemory = True 
   image = codecs.Load(fileName, 0, CodecsLoadByteOrder.BgrOrGray, 1, 1) 
 
   ' make sure the image uses unmanaged memory 
   If image.IsDiskMemory Then 
      Console.WriteLine("This image uses disk memory") 
   Else 
      Console.WriteLine("This should not happen!!") 
   End If 
 
   ' Clean up 
   image.Dispose() 
   codecs.Dispose() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Reference

CodecsLoadOptions Class

CodecsLoadOptions Members

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies