Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

Clipboard:Get Image Method

LabVIEW 2013 Help

Edition Date: June 2013

Part Number: 371361K-01

»View Product Info

Short Name: Clipboard.Get Image

Requires: Base Development System

Class: Application Methods

To Use: Create a method.

Returns the image currently stored on the clipboard.

Parameters

Data typeNameRequiredDescription
Image DepthNoSpecifies the color depth of the image, which is the number of bits to use to describe the color of each pixel in the image. Valid values include 1, 4, and 8 (default) bits per pixel.
ImageNoArray of bytes that describes the color of each pixel in the image in raster order. The value of Image Depth determines how LabVIEW interprets the value of this output. If Image Depth is 24, each pixel has three bytes to describe its color. The first byte for each pixel describes the red value, the second byte describes the green value, and the third byte describes the blue value.

If Image Depth is 8, each pixel has one byte to describe its color. The value of each bit corresponds to an element in colors, which stores 32-bit RGB values where the most-significant byte is zero, followed in order by red, green, and blue values.

If Image Depth is 4, the behavior is similar to when Image Depth is 8 except valid values in Image include 0 through 15.

If Image Depth is 1, any value of zero in Image corresponds to element 0 in colors. All other values correspond to element 1 in Colors.

The size of the array might be larger than expected due to padding.
ColorsNoArray of RGB color values that correspond to the values in Image. The value of Image Depth determines how LabVIEW interprets the value of this output. If Image Depth is 24, LabVIEW ignores this output. If Image Depth is 8, the array has 256 elements. If Image Depth is 4, the array has 16 elements. If Image Depth is 1, the array has 2 elements.
BoundsNoReturns the bounding rectangle of the image as top, left, bottom, and right values.

Remarks

The following table lists the characteristics of this method.

Data typeNo return value
Available in Run-Time EngineYes (Read/Write)
Available in Real-Time Operating SystemYes
Remote access allowedYes

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit