Class: Wx::Mask

Inherits:

Object

• Object
• Object
• Wx::Mask

Defined in:

lib/wx/doc/gen/bitmap.rb

Overview

This class encapsulates a monochrome mask bitmap, where the masked area is black and the unmasked area is white.

When associated with a bitmap and drawn in a device context, the unmasked area of the bitmap will be drawn, and the masked area will not be drawn.

Note:

A mask can be associated also with a bitmap with an alpha channel but drawing such bitmaps under WXMSW may be slow so using them should be avoided if drawing performance is an important factor.

Category: Graphics Device Interface (GDI)

See Also:

• Bitmap
• DC#blit
• MemoryDC

Instance Method Summary

• #create(*args) ⇒ Object
• #get_bitmap ⇒ Wx::Bitmap (also: #bitmap)

  Returns the mask as a monochrome bitmap.

• #initialize(*args) ⇒ Mask constructor

  A new instance of Mask.

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::Mask #initialize(bitmap, index) ⇒ Wx::Mask #initialize(bitmap) ⇒ Wx::Mask #initialize(bitmap, colour) ⇒ Wx::Mask

Returns a new instance of Mask.

Overloads:

• #initialize ⇒ Wx::Mask

  Default constructor.
• #initialize(bitmap, index) ⇒ Wx::Mask

  Constructs a mask from a bitmap and a palette index that indicates the background.

  Not implemented for GTK.

  Parameters:

  • bitmap (Wx::Bitmap) —

    A valid bitmap.

  • index (Integer) —

    Index into a palette, specifying the transparency colour.

• #initialize(bitmap) ⇒ Wx::Mask

  Constructs a mask from a monochrome bitmap.

  Parameters:

  • bitmap (Wx::Bitmap)
• #initialize(bitmap, colour) ⇒ Wx::Mask

  Constructs a mask from a bitmap and a colour that indicates the background.

  Parameters:

  • bitmap (Wx::Bitmap)
  • colour (Wx::Colour, String, Symbol)

# File 'lib/wx/doc/gen/bitmap.rb', line 672

def initialize(*args) end

Instance Method Details

#create(bitmap, index) ⇒ Boolean #create(bitmap) ⇒ Boolean #create(bitmap, colour) ⇒ Boolean

Overloads:

• #create(bitmap, index) ⇒ Boolean

  Constructs a mask from a bitmap and a palette index that indicates the background.

  Not implemented for GTK.

  Parameters:

  • bitmap (Wx::Bitmap) —

    A valid bitmap.

  • index (Integer) —

    Index into a palette, specifying the transparency colour.

  Returns:

  • (Boolean)
• #create(bitmap) ⇒ Boolean

  Constructs a mask from a monochrome bitmap.

  Parameters:

  • bitmap (Wx::Bitmap)

  Returns:

  • (Boolean)
• #create(bitmap, colour) ⇒ Boolean

  Constructs a mask from a bitmap and a colour that indicates the background.

  Parameters:

  • bitmap (Wx::Bitmap)
  • colour (Wx::Colour, String, Symbol)

  Returns:

  • (Boolean)

# File 'lib/wx/doc/gen/bitmap.rb', line 690

def create(*args) end

#get_bitmap ⇒ Wx::Bitmap Also known as: bitmap

Returns the mask as a monochrome bitmap.

Currently this method is implemented in WXMSW, WXGTK and WXOSX.

Returns:

• (Wx::Bitmap)

# File 'lib/wx/doc/gen/bitmap.rb', line 696

def get_bitmap; end