←Select platform

SetRowColumnCompressed(byte[],ushort[],int,int,int,int) Method

Summary

Puts a row (or part of a row) of 1-bit compressed data from a buffer into an image that is maintained in its compressed format.

Syntax
C#
VB
Java
Objective-C
C++
[CLSCompliantAttribute(false)] 
public int SetRowColumnCompressed( 
   byte[] workBuffer, 
   ushort[] runBuffer, 
   int runBufferOffset, 
   int row, 
   int column, 
   int width 
) 
<CLSCompliantAttribute(False)> 
Public Overloads Function SetRowColumnCompressed( _ 
   ByVal workBuffer() As Byte, _ 
   ByVal runBuffer() As UShort, _ 
   ByVal runBufferOffset As Integer, _ 
   ByVal row As Integer, _ 
   ByVal column As Integer, _ 
   ByVal width As Integer _ 
) As Integer 
- (NSInteger)setRowColumnCompressed:(unsigned char *)workBuffer  
                          runBuffer:(const unsigned short *)runBuffer  
                                row:(NSInteger)row  
                             column:(NSInteger)column  
                              width:(NSUInteger)pixels  
                              error:(NSError **)error 
public int setRowColumnCompressed( 
  byte[] workBuffer,  
  short[] runBuffer,  
  int runBufferOffset,  
  int row,  
  int column,  
  int width 
) 
[CLSCompliantAttribute(false)] 
public: 
int SetRowColumnCompressed(  
   array<byte>^ workBuffer, 
   array<ushort>^ runBuffer, 
   int runBufferOffset, 
   int row, 
   int column, 
   int width 
)  

Parameters

workBuffer
Optional work buffer. Allocating the work buffer speeds processing if you call this method more than once, because if you do not allocate a work buffer, the method allocates and frees a temporary buffer each time it is called. The size of this buffer should be the same as the image's BytesPerLine property. Pass a null reference to runBuffer if you do not want to use a work buffer.

runBuffer
Input buffer, which contains 1-bit compressed image data.

runBufferOffset
Offset into runBuffer where the set operation should start.

row
The number of the row to update. The first row is 0, and the last row is 1 less than the image height.

column
The column offset within the row to update. The first column offset is 0, and the last column offset is 1 less than the image width.

width
The number of pixels to retrieve.

Return Value

The number of pixels processed.

Remarks

This method is available in the (Document/Medical only) Toolkits.

This method is useful for working with 1-bit images that are loaded in their compressed formats for faster loading and display.

For more information, refer to Speeding Up 1-Bit Documents.

Example

For an example, refer to GetRowColumnCompressed.

Requirements

Target Platforms

Help Version 20.0.2019.3.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools Assembly