poIImagePlane GetMipMapModeList

Gets the list of mipmap modes available for an image plane.

Syntax

Imageplane_handle GetMipMapModeList

Application

HyperView Tcl Query

Description

Mipmaps are a way to shrink an image while retaining detail, before rending the final image to the display. Some mipmap modes work better than others, depending on the type of image being drawn and how much it is being shrunk. This command returns the list of mipmap modes that can be specified for an image plane.

Example

To create one image plane, and then query it for available filter types, modes, and mipmap modes:
hwi OpenStack
if {[catch {
    hwi GetSessionHandle session_handle
    session_handle GetProjectHandle project_handle
    project_handle GetPageHandle page_handle [project_handle GetActivePage]
    page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
    window_handle GetClientHandle client_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 SetLabel "Company Logo";
    set filterTypes [imageplane_handle GetFilterTypeList];
    puts "********";
    puts "Image Plane Filter Types and Modes";
    foreach fType $filterTypes {
        puts "Filter Type $fType: ";
        set filterModes [imageplane_handle GetFilterModeList $fType];
        puts "  Filter Modes: $filterModes";
    }
    set mipMapModeList [imageplane_handle GetMipMapModeList];
    puts "Image Plane MipMap Mode List: ";
    puts "  $mipMapModeList";
    puts "********";
    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

Console Output:

********
Image Plane Filter Types and Modes
Filter Type None: 
  Filter Modes: 
Filter Type Edge: 
  Filter Modes: Prewitt Laplacian Sobel
Filter Type ColorAlpha: 
  Filter Modes: Equal Lesserthan Greaterthan
Image Plane MipMap Mode List: 
    None Nearest1 Nearest2 Linear1 Linear2
********
No errors.
Warnings: 

Errors

Returns HW_InvalidHandle if the image plane handle is invalid.