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