Up
Authors
- Adam Fedor (
fedor@gnu.org
)
-
Bitmap image representation.
Copyright: (C) 1996, 2003, 2004 Free Software Foundation, Inc.
NSBitmapImageRep is an image representation for handling images composed of pixels. The standard image format for NSBitmapImageRep is the TIFF format. However, through the use of image filters and other methods, many other standard image formats can be handled by NSBitmapImageRep. Images are typically handled through the NSImage class and there is often no need to use the NSBitmapImageRep class directly. However there may be cases where you want to manipulate the image bitmap data directly.
- Declared in:
- AppKit/NSBitmapImageRep.h
Availability: OpenStep
Description forthcoming.
Instance Variables
Method summary
+ (NSData*)
TIFFRepresentationOfImageRepsInArray: (NSArray*)anArray;
Availability: OpenStep
Produces an NSData object containing a TIFF representation of all the images stored in anArray. BUGS: Currently this only works if the images are NSBitmapImageRep objects, and it only creates an TIFF from the first image in the array.
+ (NSData*)
TIFFRepresentationOfImageRepsInArray: (NSArray*)anArray
usingCompression: (
NSTIFFCompression)type
factor: (float)factor;
Availability: OpenStep
Produces an NSData object containing a TIFF representation of all the images stored in anArray. The image is compressed according to the compression type and factor . BUGS: Currently this only works if the images are NSBitmapImageRep objects, and it only creates an TIFF from the first image in the array.
+ (void)
getTIFFCompressionTypes: (const
NSTIFFCompression**)list
count: (int*)numTypes;
Availability: OpenStep
Description forthcoming.
+ (id)
imageRepWithData: (NSData*)imageData;
Availability: OpenStep
Returns a newly allocated NSBitmapImageRep object representing the image stored in imageData. If the image data contains more than one image, the first one is choosen.
See Also: +imageRepWithData:
+ (NSArray*)
imageRepsWithData: (NSData*)imageData;
Availability: OpenStep
Returns an array containing newly allocated NSBitmapImageRep objects representing the images stored in imageData.
See Also: +imageRepWithData:
+ (NSString*)
localizedNameForTIFFCompressionType: (
NSTIFFCompression)type;
Availability: OpenStep
Description forthcoming.
+ (NSData*)
representationOfImageRepsInArray: (NSArray*)imageReps
usingType: (
NSBitmapImageFileType)storageType
properties: (NSDictionary*)properties;
Availability: MacOS-X 10.0.0
Description forthcoming.
- (NSData*)
TIFFRepresentation;
Availability: OpenStep
Returns an NSData object containing a TIFF representation of the receiver.
- (NSData*)
TIFFRepresentationUsingCompression: (
NSTIFFCompression)type
factor: (float)factor;
Availability: OpenStep
Returns an NSData object containing a TIFF representation of the receiver. The TIFF data is compressed using compresssion type and factor.
- (unsigned char*)
bitmapData;
Availability: OpenStep
Returns the first plane of data representing the image.
- (int)
bitsPerPixel;
Availability: OpenStep
Returns the number of bits need to contain one pixels worth of data. This is normally the number of samples per pixel times the number of bits in one sample.
- (int)
bytesPerPlane;
Availability: OpenStep
Returns the number of bytes in a plane. This is the number of bytes in a row times tne height of the image.
- (int)
bytesPerRow;
Availability: OpenStep
- (BOOL)
canBeCompressedUsing: (
NSTIFFCompression)compression;
Availability: OpenStep
Returns YES
if the receiver can be stored in a representation compressed using the compression type.
- (void)
colorizeByMappingGray: (float)midPoint
toColor: (
NSColor*)midPointColor
blackMapping: (
NSColor*)shadowColor
whiteMapping: (
NSColor*)lightColor;
Availability: MacOS-X 10.0.0
Description forthcoming.
- (void)
getBitmapDataPlanes: (unsigned char**)data;
Availability: OpenStep
Files the array
data with pointers to each of the
data planes representing the image. The
data array must be allocated to contain at least
-samplesPerPixel
pointers.
- (void)
getCompression: (
NSTIFFCompression*)compression
factor: (float*)factor;
Availability: OpenStep
Returns the receivers
compression and
compression factor, which is set either when the image is read in or by
-setCompression:factor:
. Factor is ignored in many
compression schemes. For JPEG
compression,
factor can be any value from 0 to 255, with 255 being the maximum
compression.
- (id)
initWithBitmapDataPlanes: (unsigned char**)planes
pixelsWide: (int)width
pixelsHigh: (int)height
bitsPerSample: (int)bps
samplesPerPixel: (int)spp
hasAlpha: (BOOL)alpha
isPlanar: (BOOL)isPlanar
colorSpaceName: (NSString*)colorSpaceName
bytesPerRow: (int)rowBytes
bitsPerPixel: (int)pixelBits;
Availability: OpenStep
This is a designated initialiser for the class.
Initializes a newly created NSBitmapImageRep object to hold image data specified in the planes buffer and organized according to the additional arguments passed into the method.
The planes argument is an array of char pointers where each array holds a single component or plane of data. Note that if data is passed into the method via planes, the data is NOT copied and not freed when the object is deallocated. It is assumed that the data will always be available. If planes is NULL, then a suitable amount of memory will be allocated to store the information needed. One can then obtain a pointer to the planes data using the -bitmapData
or -getBitmapDataPlanes:
method.
Each component of the data is in "standard" order, such as red, green, blue for RGB color images. The transparency component, if these is one, should always be last.
The other arguments to the method consist of:
- width and height
-
The width and height of the image in pixels
- bps
-
The bits per sample or the number of bits used to store a number in one component of one pixel of the image. Typically this is 8 (bits) but can be 2 or 4, although not all values are supported.
- spp
-
Samples per pixel, or the number of components of color in the pixel. For instance this would be 4 for an RGB image with transparency.
- alpha
-
Set to
YES
if the image has a transparency component.
- isPlanar
-
Set to
YES
if the data is arranged in planes, i.e. one component per buffer as stored in the planes array. If NO
, then the image data is mixed in one buffer. For instance, for RGB data, the first sample would contain red, then next green, then blue, followed by red for the next pixel.
- colorSpaceName
-
This argument specifies how the data values are to be interpreted. Possible values include the typical colorspace names (although not all values are currently supported)
- rowBytes
-
Specifies the number of bytes contained in a single scan line of the data. Normally this can be computed from the width of the image, the samples per pixel and the bits per sample. However, if the data is aligned along word boundaries, this value may differ from this. If rowBytes is 0, the method will calculate the value assuming there are no extra bytes at the end of the scan line.
- pixelBits
-
This is normally bps for planar data and bps times spp for non-planar data, but sometimes images have extra bits. If pixelBits is 0 it will be calculated as described above.
- (id)
initWithBitmapHandle: (void*)bitmap;
Availability: MacOS-X 10.0.0
Description forthcoming.
- (id)
initWithData: (NSData*)imageData;
Availability: OpenStep
Loads only the default (first) image from the TIFF image contained in data.
- (id)
initWithFocusedViewRect: (NSRect)rect;
Availability: OpenStep
Description forthcoming.
- (id)
initWithIconHandle: (void*)icon;
Availability: MacOS-X 10.0.0
Description forthcoming.
- (BOOL)
isPlanar;
Availability: OpenStep
Returns YES
if the image components are stored separately. Returns NO
if the components are meshed (i.e. all the samples for one pixel come before the next pixel).
- (int)
numberOfPlanes;
Availability: OpenStep
Returns the number of planes in an image. Typically this is equal to the number of samples in a planar image or 1 for a non-planar image.
- (NSData*)
representationUsingType: (
NSBitmapImageFileType)storageType
properties: (NSDictionary*)properties;
Availability: MacOS-X 10.0.0
Description forthcoming.
- (int)
samplesPerPixel;
Availability: OpenStep
Returns the number of samples in a pixel. For instance, a normal RGB image with transparency would have a samplesPerPixel of 4.
- (void)
setCompression: (
NSTIFFCompression)compression
factor: (float)factor;
Availability: OpenStep
Description forthcoming.
- (void)
setProperty: (NSString*)property
withValue: (id)value;
Availability: MacOS-X 10.0.0
Description forthcoming.
- (id)
valueForProperty: (NSString*)property;
Availability: MacOS-X 10.0.0
Description forthcoming.
Instance Variables for NSBitmapImageRep Class
@protected unsigned int _bitsPerPixel;
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.
@protected unsigned int _bytesPerRow;
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.
@protected float _comp_factor;
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.
@protected unsigned short int _compression;
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.
@protected NSMutableData* _imageData;
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.
@protected unsigned char** _imagePlanes;
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.
@protected BOOL _isPlanar;
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.
@protected unsigned int _numColors;
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.
- Declared in:
- AppKit/NSBitmapImageRep.h
Availability: OpenStep
Description forthcoming.
Method summary
+ (NSArray*)
imageRepsWithFile: (NSString*)filename;
Availability: OpenStep
Description forthcoming.
Up