Source/QuartzUtils.h
author Jens Alfke <jens@mooseyard.com>
Fri Mar 07 11:43:02 2008 -0800 (2008-03-07)
changeset 0 e9f7ba4718e1
child 1 3eb7be1dd7b6
permissions -rw-r--r--
Initial check-in into Mercurial. Branched from 1.0 release of Apple's sample code. No longer requires garbage collection. Fixed some memory leaks of CG objects. Fixed a bug when advancing to the 8th row in the Checkers game.
     1 /*  This code is based on Apple's "GeekGameBoard" sample code, version 1.0.
     2     http://developer.apple.com/samplecode/GeekGameBoard/
     3     Copyright © 2007 Apple Inc. Copyright © 2008 Jens Alfke. All Rights Reserved.
     4 
     5     Redistribution and use in source and binary forms, with or without modification, are permitted
     6     provided that the following conditions are met:
     7 
     8     * Redistributions of source code must retain the above copyright notice, this list of conditions
     9       and the following disclaimer.
    10     * Redistributions in binary form must reproduce the above copyright notice, this list of
    11       conditions and the following disclaimer in the documentation and/or other materials provided
    12       with the distribution.
    13 
    14     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
    15     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
    16     FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRI-
    17     BUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    18     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
    19     PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
    20     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
    21     THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    22 */
    23 #import <Quartz/Quartz.h>
    24 
    25 
    26 /** Constants for various commonly used colors. */
    27 extern CGColorRef kBlackColor, kWhiteColor, 
    28                   kTranslucentGrayColor, kTranslucentLightGrayColor, 
    29                   kAlmostInvisibleWhiteColor,
    30                   kHighlightColor;
    31 
    32 
    33 /** Moves a layer from one superlayer to another, without changing its position onscreen. */
    34 void ChangeSuperlayer( CALayer *layer, CALayer *newSuperlayer, int index );
    35 
    36 /** Removes a layer from its superlayer without any fade-out animation. */
    37 void RemoveImmediately( CALayer *layer );
    38 
    39 /** Convenience for creating a CATextLayer. */
    40 CATextLayer* AddTextLayer( CALayer *superlayer,
    41                            NSString *text, NSFont* font,
    42                            enum CAAutoresizingMask align );
    43 
    44 
    45 /** Loads an image or pattern file into a CGImage or CGPattern.
    46     If the name begins with "/", it's interpreted as an absolute filesystem path.
    47     Otherwise, it's the name of a resource that's looked up in the app bundle.
    48     The image must exist, or an assertion-failure exception will be raised!
    49     Loaded images/patterns are cached in memory, so subsequent calls with the same name
    50     are very fast.
    51     The caller must NOT release the result, since it's retained in the cache. */
    52 CGImageRef GetCGImageNamed( NSString *name );
    53 CGColorRef GetCGPatternNamed( NSString *name );
    54 
    55 /** Loads image data from the pasteboard into a CGImage. */
    56 CGImageRef GetCGImageFromPasteboard( NSPasteboard *pb );
    57 
    58 /** Creates a CGPattern from a CGImage. Caller must release it. */
    59 CGPatternRef CreateImagePattern( CGImageRef image );
    60 
    61 /** Creates a CGColor that draws the given CGImage as a pattern. Caller must release it. */
    62 CGColorRef CreatePatternColor( CGImageRef image );
    63 
    64 /** Returns the alpha value of a single pixel in a CGImage, scaled to a particular size. */
    65 float GetPixelAlpha( CGImageRef image, CGSize imageSize, CGPoint pt );
    66 
    67 /** Returns the center point of a CGRect. */
    68 static inline CGPoint GetCGRectCenter( CGRect rect ) {
    69     return CGPointMake(CGRectGetMidX(rect),CGRectGetMidY(rect));
    70 }