# NSImage

fedor@colorado.edu
Generated at 2026-02-17 21:02:56 +0000

Load, manipulate and display images

1996-2016 Free Software Foundation, Inc.
Software documentation for the NSImage class
AppKit/NSImage.h
NSCoding
NSCopying
Description forthcoming.
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
Description forthcoming.
_standardImageWithName:
name
Warning the underscore at the start of the name of this method indicates that it is private, for internal use only, and you should not use the method in your code.
canInitWithPasteboard:
pasteboard
Description forthcoming.
imageFileTypes
Description forthcoming.
imageNamed:
aName
Returns the NSImage named aName. The search is done in the main bundle first and then in the usual images directories.
imagePasteboardTypes
Description forthcoming.
imageUnfilteredFileTypes
Description forthcoming.
imageUnfilteredPasteboardTypes
Description forthcoming.
TIFFRepresentation
Description forthcoming.
TIFFRepresentationUsingCompression:
comp
factor:
aFloat
Description forthcoming.
addRepresentation:
imageRep
Adds the NSImageRep imageRep to the NSImage's representations array.

See Also:

-addRepresentations:
-removeRepresentation:
addRepresentations:
imageRepArray
Adds the NSImageRep array imageRepArray to the NSImage's representations array.

See Also:

-addRepresentation:
-removeRepresentation:
backgroundColor
Returns the color of the NSImage's background.

See Also:

-setBackgroundColor:
bestRepresentationForDevice:
deviceDescription
Finds the best representation for deviceDescription. If deviceDescription is `nil`, it guesses where drawing is taking place and finds the best representation.
bestRepresentationForRect:
rect
context:
context
hints:
hints
Finds the best representation for drawing in the specified rect. context and hints are currently ignored.
cacheDepthMatchesImageDepth
Description forthcoming.
cacheMode
Description forthcoming.
compositeToPoint:
aPoint
fromRect:
aRect
operation:
op
Description forthcoming.
compositeToPoint:
aPoint
fromRect:
srcRect
operation:
op
fraction:
delta
Description forthcoming.
compositeToPoint:
aPoint
operation:
op
Description forthcoming.
compositeToPoint:
aPoint
operation:
op
fraction:
delta
Description forthcoming.
delegate
Description forthcoming.
dissolveToPoint:
aPoint
fraction:
aFloat
Description forthcoming.
dissolveToPoint:
aPoint
fromRect:
aRect
fraction:
aFloat
Description forthcoming.
drawAtPoint:
point
fromRect:
srcRect
operation:
op
fraction:
delta
Calls -drawAtPoint:fromRect:operation:fraction: with `dstRect` given by `point` and the size of `srcRect`.
drawInRect:
rect
Description forthcoming.
drawInRect:
dstRect
fromRect:
srcRect
operation:
op
fraction:
delta

Takes the part of the receiver given by `srcRect` and draws it in `dstRect` in the current coordinate system, transforming the image as necessary.

The image is drawn as if it was drawn to a cleared window, then dissolved using the fraction `delta` to another cleared window, and finally composited using `op` to the destination.

Note that compositing and dissolving doesn't work on all devices (printers, in particular).

drawInRect:
dstRect
fromRect:
srcRect
operation:
op
fraction:
delta
respectFlipped:
respectFlipped
hints:
hints
Base drawing method in NSImage; all other draw methods call this one
We only use caching on backends that can efficiently draw a rect from the cache onto the current graphics context respecting the CTM, which is currently cairo.
drawRepresentation:
imageRep
inRect:
aRect
Description forthcoming.
initByReferencingFile:
fileName
Initializes and returns a NSImage from the NSString fileName.
initWithBitmapHandle:
bitmap
Description forthcoming.
initWithContentsOfFile:
fileName
Initializes and returns a new NSImage from the file fileName. fileName should be an absolute path.

See Also:

[NSImageRep +imageRepsWithContentsOfFile:]
initWithContentsOfURL:
anURL
Description forthcoming.
initWithData:
data
Initializes and returns a new NSImage from the NSData data.

See Also:

[NSBitmapImageRep +imageRepWithData:]
[NSEPSImageRep +imageRepWithData:]
initWithIconHandle:
icon
Description forthcoming.
initWithPasteboard:
pasteboard
Initializes and returns a new NSImage from the data in pasteboard. The pasteboard types can be whose defined in [NSImageRep +imagePasteboardTypes] or NSFilenamesPboardType

See Also:

[NSImageRep +imageRepsWithPasteboard:]
initWithSize:
aSize
Initialize and returns a new NSImage with aSize as specified size.

See Also:

-setSize:
-size
isCachedSeparately
Description forthcoming.
isDataRetained
Description forthcoming.
isFlipped
Description forthcoming.
isValid
Description forthcoming.
lockFocus
Locks the focus on the best representation.

See Also:

-lockFocusOnRepresentation:
lockFocusOnRepresentation:
imageRep
Locks the focus in the imageRep. If imageRep is `nil` this method locks the focus on the best representation.
matchesOnMultipleResolution
Description forthcoming.
name
Returns the name of the receiver.
prefersColorMatch
Returns `YES` if color matching is the preferred representation and `NO` otherwise.
recache
Description forthcoming.
removeRepresentation:
imageRep
Remove the NSImageRep imageRep from the NSImage's representations array

See Also:

-addRepresentations:
-addRepresentation:
representations
Description forthcoming.
scalesWhenResized
Description forthcoming.
setBackgroundColor:
aColor
Sets the color of the NSImage's background to aColor.

See Also:

-backgroundColor
setCacheDepthMatchesImageDepth:
flag
Description forthcoming.
setCacheMode:
mode
Description forthcoming.
setCachedSeparately:
flag
Description forthcoming.
setDataRetained:
flag
Description forthcoming.
setDelegate:
anObject
Description forthcoming.
setFlipped:
flag
Description forthcoming.
setMatchesOnMultipleResolution:
flag
Description forthcoming.
setName:
aName
Sets aName as the name of the receiver.
setPrefersColorMatch:
flag
Sets the preferred representation of a NSImage.

See Also:

-prefersColorMatch
-bestRepresentationForDevice:
setScalesWhenResized:
flag
Description forthcoming.
setSize:
aSize
Sets the NSImage size to aSize. Changing the size recreate the cache.

See Also:

-size
-initWithSize:
setUsesEPSOnResolutionMismatch:
flag
Description forthcoming.
size
Returns NSImage size if the size have been set. Returns the size of the best representation otherwise.

See Also:

-setSize:
-initWithSize:
unlockFocus
Unlocks the focus on the receiver.

See Also:

-lockFocus
usesEPSOnResolutionMismatch
Description forthcoming.
Software documentation for the NSBundle(NSImageAdditions) category
AppKit/NSImage.h
Description forthcoming.
pathForImageResource:
name
Description forthcoming.
Software documentation for the NSImage(GSQuartz) category
AppKit/NSImage.h
Description forthcoming.
CGImageForProposedRect:
proposedDestRect
context:
referenceContext
hints:
hints
Description forthcoming.
Software documentation for the GSImageDelegateProtocol protocol
AppKit/NSImage.h
Description forthcoming.
imageDidNotDraw:
sender
inRect:
aRect
Description forthcoming.