TIP 14: Access to Tk Photo Image Transparency

Author:         Donal K. Fellows <[email protected]>
State:          Final
Type:           Project
Vote:           Done
Created:        22-Nov-2000
Keywords:       Tk,photo,transparency,internal,access
Tcl-Version:    8.4.0
Implementation-URL: http://www.cs.man.ac.uk/~fellowsd/tcl/validRegion.patch


It is useful for some code (both extensions and scripts) to have access to the transparency information in photo images for various reasons, but this is not currently available, even via an internal structure defined in generic/tkInt.h. This TIP is aimed at making the information available, and in such a way at the C level that backward compatibility is maintained in the future even if the internal structure definitions change.


I have been working for several years (on-and-off) on an extension for Tk that allows it to have non-rectangular windows (http://www.cs.man.ac.uk/~fellowsd/tcl/shapeidx.html\) which is an effect that is great for all sorts of purposes but which comes particularly into its own when used in conjunction with drag-and-drop to make drag tokens that obscure only part of what lies underneath them. However, one of the most useful ways of specifying the shape of a window turns out to be via images of various kinds, and the natural way to do this is with the transparency data within the image. The problem is that this data is locked up entirely within structures that are completely private to generic/tkImgPhoto.c; none of it is visible at all anywhere else, even within the core. (There is code that uses colour data instead to do this sort of trick, http://www.sys.uea.ac.uk/~fuzz/tktrans/default.html, but this is a slow process and frankly a little strange if we already have transparency data available.)

There is also a more general need for scripts to be able to discover more about the transparent areas of a photo image; at the moment, there is no access at all to that information at the script level.

Changes to the C-Level API

To get around this problem, the data member validRegion of the PhotoMaster structure needs to be made available by some mechanism. There are two ways of doing this:

  1. Placing the PhotoMaster structure, or some version of it, in generic/tkInt.h, or

  2. Creating a function to access the data member.

The first way is very cheap initially, but also very inflexible and creates yet another hidden version dependency (such as is tackled in [5]) should we decide to change the structure for any reason (we also have had problems with this sort of thing in the past in relation to the Tcl_Interp member result, direct access to which has been deprecated for years, but where there is still existing code that does it and which forms one of the largest barriers for some extensions from upgrading to Tcl 8.0 or later.) It is also unnecessary since only the core needs to know how to create new instances of the structure.

The second way, by contrast, is far more flexible in the future as it will allow us to completely change the internal implementation of photo image transparency without affecting any extensions at all. The cost of doing this is that a new entry in one of the stub tables must be created. Due to the fact that the type of the validRegion member is (currently) internal, I propose adding the function to the tkInt stub interface, and I propose calling the function TkPhotoGetValidRegion.

Changes to the Tcl-Level API

I propose to add an extra subcommand to photo image instances which will provide all the access to and manipulation of transparency data. I propose to call this subcommand transparency and it will have subsubcommands to provide access to the various facilities it provides. Initially I will provide a get subsubcommand to allow the testing of the transparency of a single pixel (returned as a boolean value), and a set subsubcommand to allow the setting of the transparency of a single pixel. I anticipate that these will be expanded in the future to allow the manipulation of transparencies of rectangular regions (both getting and setting) but I do not supply such at this stage.

   image create photo phImg -file thingy.gif
   if {[phImg transparency get 0 0]} {
      # Top-left pixel is transparent...

   # Toggle transparency...
   phImg transparency set 0 0 [expr {![phImg transparency get 0 0]}]

Sample Implementation Patches

Exposing the transparency to C: http://www.cs.man.ac.uk/~fellowsd/tcl/validRegion.patch

Exposing the transparency to Tcl: http://www.cs.man.ac.uk/~fellowsd/tcl/patches/transCmd.patch


This document is placed in the public domain.