NSImageMBS.addRepresentation(img as NSImageRepMBS)

After invoking this method, you may need to explicitly set features of the new image representation, such as the size, number of colors, and so on. This is true particularly when the NSImage object has multiple image representations to choose from. See NSImageRep and its subclasses for the methods you use to complete initialization.

Any representation added by this method is retained by the receiver. Image representations cannot be shared among multiple NSImage objects.

Some examples using this method:

• /MacBase/ConvertToSRGB
• /MacCocoa/NSImage EPS Test/NSImage EPS Test
• /MacCocoa/NSWorkSpace Icon Images
• /MacControls/Popupmenu Retina Icons
• /MacControls/Toolbar/Toolbar with retina Icons

NSImageMBS.BMPRepresentation as Memoryblock

Var img as NSImageMBS
Var p as Picture
Var f as FolderItem
Var b as BinaryStream

p=New Picture(100,100,32)
p.Graphics.ForeColor=&cFF0000
p.Graphics.FillOval 0,0,100,100
Backdrop=p
img=new NSImageMBS(p,p.Mask)

f=SpecialFolder.Desktop.Child("test.bmp")
b=f.CreateBinaryFile("")
b.Write img.BMPRepresentation
b.Close

f.Launch

BMP does not support masks.

NSImageMBS.BMPRepresentationMT as Memoryblock

BMP does not support masks.

The work is performed on a preemptive thread, so this function does not block the application and can yield time to other Xojo threads. Must be called in a Xojo thread to enjoy benefits. If called in main thread will block, but keep other background threads running.
If you run several threads calling MT methods, you can get all CPU cores busy while main thread shows GUI with progress window.

NSImageMBS.cancelIncrementalLoad

This call has no effect if the image is not loading.

NSImageMBS.Constructor

See also:

• Constructor(data as Memoryblock)
• Constructor(file as folderitem)
• Constructor(image as Picture, mask as picture = nil)
• Constructor(width as Double, height as Double)

NSImageMBS.Constructor(data as Memoryblock)

Calls initWithData.
On success the image is valid and the handle is not zero.

See also:

• Constructor
• Constructor(file as folderitem)
• Constructor(image as Picture, mask as picture = nil)
• Constructor(width as Double, height as Double)

NSImageMBS.Constructor(file as folderitem)

Calls initWithContentsOfURL.
On success the image is valid and the handle is not zero.

See also:

• Constructor
• Constructor(data as Memoryblock)
• Constructor(image as Picture, mask as picture = nil)
• Constructor(width as Double, height as Double)

NSImageMBS.Constructor(image as Picture, mask as picture = nil)

Var img as new NSImageMBS(pict)

Optional you can pass a picture with the mask. It is valid to use the mask property of the image for the second parameter.

With 11.3 plugins we are deprecating to pass a mask. The plugin prefers to simply take the mask or alpha channel of the picture itself.

On success the image is valid and the handle is not zero.
Calls initWithPicture.

See also:

• Constructor
• Constructor(data as Memoryblock)
• Constructor(file as folderitem)
• Constructor(width as Double, height as Double)

NSImageMBS.Constructor(width as Double, height as Double)

Calls initWithSize.
On success the image is valid and the handle is not zero.

See also:

• Constructor
• Constructor(data as Memoryblock)
• Constructor(file as folderitem)
• Constructor(image as Picture, mask as picture = nil)

NSImageMBS.CopyMask as picture

Var f as FolderItem
Var n as NSImageMBS

f=SpecialFolder.Desktop.Child("test.png")
n=new NSImageMBS(f)
Backdrop=n.CopyMask

Copies only the alpha channel as mask.
Returns nil on any error.

Not implemented for iOS.

NSImageMBS.CopyPicture(CGColorSpace as Variant = nil, BackgroundColor as NSColorMBS = nil) as picture

Var f as FolderItem
Var n as NSImageMBS

f=SpecialFolder.Desktop.Child("test.png")
n=new NSImageMBS(f)
Backdrop=n.CopyPicture // background is black

A convenience function instead of using CGPictureContextMBS with DrawIntoCGContextAtRect.

Returns nil on any error.

With Colorspace parameter you can pass a RGB CGColorspace to define which colorspace is used. Default is DeviceRGB, but you could also pass generic RGB or other.

If BackgroundColor is not nil, the image is filled in background with this color and NSImage rendered on top of it.

Implemented for iOS in v22.4 to return underlaying UIImage as Xojo picture. Colorspace and background are ignored as picture is passed directly.

NSImageMBS.CopyPictureRect(x as Integer, y as Integer, w as Integer, h as Integer, CGColorSpace as Variant = nil, BackgroundColor as NSColorMBS = nil) as picture

Var f as FolderItem
Var n as NSImageMBS

f=SpecialFolder.Desktop.Child("test.png")
n=new NSImageMBS(f)
Backdrop=n.CopyPicture // background is black

A convenience function instead of using CGPictureContextMBS with DrawIntoCGContextAtRect.

Returns nil on any error.

With Colorspace parameter you can pass a RGB CGColorspace to define which colorspace is used. Default is DeviceRGB, but you could also pass generic RGB or other.

If BackgroundColor is not nil, the image is filled in background with this color and NSImage rendered on top of it.

Not implemented for iOS.

NSImageMBS.CopyPictureWithAlpha as picture

This is a function for Cocoa target which returns picture with alpha channel.
Returns nil on any error.

Not implemented for iOS.

NSImageMBS.CopyPictureWithAlphaRect(x as Integer, y as Integer, w as Integer, h as Integer) as picture

This is a function for Cocoa target which returns picture with alpha channel.
Returns nil on any error.

Not implemented for iOS.

NSImageMBS.CopyPictureWithMask(CGColorSpace as Variant = nil) as picture

Var f as FolderItem
Var n as NSImageMBS

f=SpecialFolder.Desktop.Child("test.png")
n=new NSImageMBS(f)
Backdrop=n.CopyPictureWithMask

Copies the picture and its mask.
This function is faster than CopyPicture and CopyMask combined as the picture is only copied one time to an internal buffer.

A convenience function instead of using CGPictureContextMBS with DrawIntoCGContextAtRect.

Returns nil on any error.

With Colorspace parameter you can pass a RGB CGColorspace to define which colorspace is used. Default is DeviceRGB, but you could also pass generic RGB or other.

Not implemented for iOS.

NSImageMBS.DrawIntoCGContextAtPoint(cgcontext as Integer, x as Double, y as Double, sx as Double, sy as Double, SourceW as Double, SourceH as Double, operation as Integer, fraction as Double) as boolean

Same as DrawIntoCGContextAtRect, but with a point instead of a rectangle.

NSImageMBS.DrawIntoCGContextAtRect(cgcontext as Integer, x as Double, y as Double, w as Double, h as Double, SourceX as Double, SourceY as Double, SourceW as Double, SourceH as Double, operation as Integer, fraction as Double) as boolean

Function OpenAsNSimage(extends file as folderitem) As picture
  Var width as Integer
  Var height as Integer
  Var c as NSImageMBS
  Var g as CGPictureContextMBS
  
  // load image from file
  c=new NSImageMBS
  
  // is that image valid?
  if c.initWithContentsOfURL(file) then
    Width=c.Width
    height=c.Height
    
    // create a drawing buffer to draw inside
    g=new CGPictureContextMBS(width,height)
    
    if g.Handle<>0 then // valid?
      
      // now draw the image inside.
      // you could scale or even apply transparency...
      if c.DrawIntoCGContextAtRect(g.Handle, 0, 0, width, height, 0,0,width,height,2,1.0) then
        // make a RB Picture from it
        Return g.CopyPicture
      end if
    end if
  end if
End Function

Draws the image into a CGContext. You need to specify first the destination rectangle followed by the source rectangle.

fraction:
The opacity of the image, specified as a value from 0.0 to 1.0. Specifying a value of 0.0 draws the image as fully transparent while a value of 1.0 draws the image as fully opaque. Values greater than 1.0 are interpreted as 1.0.

operation codes:

NSCompositeClear	= 0	Transparent.
NSCompositeCopy	= 1	Source image.
NSCompositeSourceOver	= 2	Source image wherever source image is opaque, and destination image elsewhere.
NSCompositeSourceIn	= 3	Source image wherever both images are opaque, and transparent elsewhere.
NSCompositeSourceOut	= 4	Source image wherever source image is opaque but destination image is transparent, and transparent elsewhere.
NSCompositeSourceAtop	= 5	Source image wherever both images are opaque, destination image wherever destination image is opaque but source image is transparent, and transparent elsewhere.
NSCompositeDestinationOver	= 6	Destination image wherever destination image is opaque, and source image elsewhere.
NSCompositeDestinationIn	= 7	Destination image wherever both images are opaque, and transparent elsewhere.
NSCompositeDestinationOut	= 8	Destination image wherever destination image is opaque but source image is transparent, and transparent elsewhere.
NSCompositeDestinationAtop	= 9	Destination image wherever both images are opaque, source image wherever source image is opaque but destination image is transparent, and transparent elsewhere.
NSCompositeXOR	= 10	Exclusive OR of source and destination images.
NSCompositePlusDarker	= 11	Sum of source and destination images, with color values approaching 0 as a limit.
NSCompositeHighlight	= 12	Source image wherever source image is opaque, and destination image elsewhere.
NSCompositePlusLighter	= 13	Sum of source and destination images, with color values approaching 1 as a limit.

Returns true on success and false on failure.

Some examples using this method:

• /MacCocoa/NSImage/Open Image using NSImage

NSImageMBS.GIFRepresentation as Memoryblock

Var img as NSImageMBS
Var p as Picture
Var f as FolderItem
Var b as BinaryStream

p=New Picture(100,100,32)
p.Graphics.ForeColor=&cFF0000
p.Graphics.FillOval 0,0,100,100
Backdrop=p
img=new NSImageMBS(p,p.Mask)

f=SpecialFolder.Desktop.Child("test.gif")
b=f.CreateBinaryFile("")
b.Write img.GIFRepresentation
b.Close

f.Launch

GIF does support masks in a limited way.

NSImageMBS.GIFRepresentationMT as Memoryblock

GIF does support masks in a limited way.

The work is performed on a preemptive thread, so this function does not block the application and can yield time to other Xojo threads. Must be called in a Xojo thread to enjoy benefits. If called in main thread will block, but keep other background threads running.
If you run several threads calling MT methods, you can get all CPU cores busy while main thread shows GUI with progress window.

NSImageMBS.imageByFadingToFraction(fraction as Double) as NSImageMBS

Var img as NSImageMBS
Var p as Picture
Var f as FolderItem
Var b as BinaryStream

p=New Picture(100,100,32)
p.Graphics.ForeColor=&cFF0000
p.Graphics.FillOval 0,0,100,100
Backdrop=p
img=new NSImageMBS(p)

img=img.imageByFadingToFraction(0.1)

f=SpecialFolder.Desktop.Child("test.png")
b=f.CreateBinaryFile("")
b.Write img.PNGRepresentation
b.Close

f.Launch

Returns nil on failure.

NSImageMBS.imageByScalingToSize(width as Double, height as Double) as NSImageMBS

Var img as NSImageMBS
Var p as Picture
Var f as FolderItem
Var b as BinaryStream

p=New Picture(100,100,32)
p.Graphics.ForeColor=&cFF0000
p.Graphics.FillOval 0,0,100,100
Backdrop=p
img=new NSImageMBS(p)

img=img.imageByScalingToSize(200,200)

f=SpecialFolder.Desktop.Child("test.png")
b=f.CreateBinaryFile("")
b.Write img.PNGRepresentation
b.Close

f.Launch

Returns nil on failure.
Internally creates a copy of the image.

See also:

• imageByScalingToSize(width as Double, height as Double, fraction as Double) as NSImageMBS
• imageByScalingToSize(width as Double, height as Double, fraction as Double, flip as boolean, proportionally as boolean) as NSImageMBS

Some examples using this method:

• /MacCocoa/Addressbook/List of People with images

NSImageMBS.imageByScalingToSize(width as Double, height as Double, fraction as Double) as NSImageMBS

Var img as NSImageMBS
Var p as Picture
Var f as FolderItem
Var b as BinaryStream

p=New Picture(100,100,32)
p.Graphics.ForeColor=&cFF0000
p.Graphics.FillOval 0,0,100,100
Backdrop=p
img=new NSImageMBS(p)

img=img.imageByScalingToSize(200,200,0.5)

f=SpecialFolder.Desktop.Child("test.png")
b=f.CreateBinaryFile("")
b.Write img.PNGRepresentation
b.Close

f.Launch

Returns nil on failure.
Internally creates a copy of the image.

See also:

• imageByScalingToSize(width as Double, height as Double) as NSImageMBS
• imageByScalingToSize(width as Double, height as Double, fraction as Double, flip as boolean, proportionally as boolean) as NSImageMBS

NSImageMBS.imageByScalingToSize(width as Double, height as Double, fraction as Double, flip as boolean, proportionally as boolean) as NSImageMBS

Var img as NSImageMBS
Var p as Picture
Var f as FolderItem
Var b as BinaryStream

p=New Picture(100,100,32)
p.Graphics.ForeColor=&cFF0000
p.Graphics.FillOval 0,0,100,100
Backdrop=p
img=new NSImageMBS(p)

img=img.imageByScalingToSize(200,200)

f=SpecialFolder.Desktop.Child("test.png")
b=f.CreateBinaryFile("")
b.Write img.PNGRepresentation
b.Close

f.Launch

Returns nil on failure.
The image can be flipped vertically with the flip property.
Internally creates a copy of the image.

See also:

• imageByScalingToSize(width as Double, height as Double) as NSImageMBS
• imageByScalingToSize(width as Double, height as Double, fraction as Double) as NSImageMBS

NSImageMBS.imageWithSymbolConfiguration(configuration as NSImageSymbolConfigurationMBS) as NSImageMBS

Var config As NSImageSymbolConfigurationMBS = NSImageSymbolConfigurationMBS.configurationWithPointSize(40, 0)
Var n As NSImageMBS = NSImageMBS.imageWithSystemSymbolName("trash")
Var o As NSImageMBS = n.imageWithSymbolConfiguration(config)

Backdrop = o.CopyPictureWithAlpha

NSImageMBS.imageWithTintColor(tintColor as NSColorMBS) as NSImageMBS

Input image should be grayscale.

NSImageMBS.initWithContentsOfURL(file as folderitem) as boolean

Returns true on success and false on failure.

See also:

• initWithContentsOfURL(url as string) as boolean

NSImageMBS.initWithContentsOfURL(url as string) as boolean

Returns true on success and false on failure.

See also:

• initWithContentsOfURL(file as folderitem) as boolean

NSImageMBS.initWithData(data as Memoryblock) as boolean

Returns true on success and false on failure.

NSImageMBS.initWithDataIgnoringOrientation(data as Memoryblock) as boolean

An initialized NSImage instance, or nil if the method cannot create an image representation from the contents of the specified data object.
Available in Mac OS X v10.6 and later.

NSImageMBS.initWithIconRef(IconHandle as Integer) as boolean

IconHandle: A reference to a Carbon icon resource (IconRef).

Creates one or more bitmap image representations, one for each size icon contained in the IconRef data structure. This initialization method automatically retains the data in the iconRef parameter and loads the bitmaps from that data file lazily.
Available in Mac OS X v10.5 and later.

NSImageMBS.initWithPasteboard as boolean

The specified pasteboard should contain a type supported by one of the registered NSImageRep subclasses. Table 1 lists the default pasteboard types and file extensions for several NSImageRep subclasses.

NSImageMBS.initWithPicture(img as picture, mask as picture = nil) as boolean

Var img as new NSImageMBS
if img.initWithPicture(pict, pict.mask) then
  MsgBox "OK"
end if

Optional you can pass a picture with the mask. It is valid to use the mask property of the image for the second parameter.

With 11.3 plugins we are deprecating to pass a mask. The plugin prefers to simply take the mask or alpha channel of the picture itself.

On success the image is valid and the handle is not zero.

Some examples using this method:

• /MacCocoa/EasyStatusItem