poIImagePlane GetColorAlphaTarget

Gets the color that will be made transparent when the ColorAlpha image post-processing filter is active on the image plane.

Syntax

Imageplane_handle GetColorAlphaTarget

Application

HyperView Tcl Query

Description

The image plane offers several image post-processing filters that can be applied on the image or video. The ColorAlpha filter makes the target color in the image or video transparent. This command returns the RGB value of the target color as a series of three values between 0 and 255.

Console Output:

Filter Type: ColorAlpha
  Filter Mode: Equal
  Alpha Color Target: 255 255 255
  Alpha Color Tolerance: 18
  MipMap Mode: Linear1
No errors.
Warnings:

Example

To create one image plane, configure the ColorAlpha filter, and then query the object for its settings:
hwi OpenStack
if {[catch {
    hwi GetActiveClientHandle client_handle
    hwi GetSessionHandle session_handle
    client_handle GetImagePlaneCtrlHandle ipc_handle
    set ipid1 [ipc_handle AddImagePlane Logo1]
    ipc_handle GetImagePlaneHandle imageplane_handle $ipid1
    imageplane_handle SetFileName g:/samples2/VideoOverlay/Altair_logo.jpg
    imageplane_handle SetMode background
    imageplane_handle SetCrop 0 0 0.9995 0.995
    imageplane_handle SetFilterType ColorAlpha;
    imageplane_handle SetFilterMode equal;
    imageplane_handle SetColorAlphaTarget "255 255 255"
    imageplane_handle SetColorAlphaTolerance 18
    imageplane_handle SetMipMapMode Linear1
    puts "  Filter Type: [imageplane_handle GetFilterType]";
    puts "  Filter Mode: [imageplane_handle GetFilterMode]";
    puts "  Alpha Color Target: [imageplane_handle GetColorAlphaTarget]";
    puts "  Alpha Color Tolerance: [imageplane_handle GetColorAlphaTolerance]";
    puts "  MipMap Mode: [imageplane_handle GetMipMapMode]";
    client_handle Draw
} result]} {
    global errorInfo;
    puts stderr $result;
    puts "[session_handle GetError]";
    puts stderr "*** Tcl TRACE ***";
    puts stderr $errorInfo;
} else { 
    puts "No errors.";
    puts "Warnings: ";
    puts "    [session_handle GetError]";
}

hwi CloseStack

Errors

Returns HW_InvalidHandle if the image plane handle is invalid.