Skip to content

Commit dd3f4dc

Browse files
committed
Updated documentation to reflect new framework targets.
1 parent 056447b commit dd3f4dc

2 files changed

Lines changed: 29 additions & 3 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,18 @@ Additionally, this is an ARC-enabled framework, so if you want to use this withi
7676

7777
If you don't want to include the project as a dependency in your application's Xcode project, you can build a universal static library for the iOS Simulator or device. To do this, run `build.sh` at the command line. The resulting library and header files will be located at `build/Release-iphone`. You may also change the version of the iOS SDK by changing the `IOSSDK_VER` variable in `build.sh` (all available versions can be found using `xcodebuild -showsdks`).
7878

79+
## Adding this as a framework (module) to your Mac or iOS project ##
80+
81+
Xcode 6 and iOS 8 support the use of full frameworks, as does the Mac, which simplifies the process of adding this to your application. To add this to your application, I recommend dragging the .xcodeproj project file into your application's project (as you would in the static library target).
82+
83+
For your application, go to its target build settings and choose the Build Phases tab. Under the Target Dependencies grouping, add GPUImageFramework on iOS (not GPUImage, which builds the static library) or GPUImage on the Mac. Under the Link Binary With Libraries section, add GPUImage.framework.
84+
85+
This should cause GPUImage to build as a framework. Under Xcode 6, this will also build as a module, which will allow you to use this in Swift projects. When set up as above, you should just need to use
86+
87+
import GPUImage
88+
89+
to pull it in.
90+
7991
### Documentation ###
8092

8193
Documentation is generated from header comments using appledoc. To build the documentation, switch to the "Documentation" scheme in Xcode. You should ensure that "APPLEDOC_PATH" (a User-Defined build setting) points to an appledoc binary, available on <a href="https://github.com/tomaz/appledoc">Github</a> or through <a href="https://github.com/mxcl/homebrew">Homebrew</a>. It will also build and install a .docset file, which you can view with your favorite documentation tool.

framework/GPUImage.xcodeproj/project.pbxproj

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,14 @@
115115
BC56D84B157ADA4F00CC9C1E /* GPUImageDilationFilter.m in Sources */ = {isa = PBXBuildFile; fileRef = BC56D849157ADA4F00CC9C1E /* GPUImageDilationFilter.m */; };
116116
BC56D84F157ADA6F00CC9C1E /* GPUImageErosionFilter.h in Headers */ = {isa = PBXBuildFile; fileRef = BC56D84D157ADA6F00CC9C1E /* GPUImageErosionFilter.h */; };
117117
BC56D850157ADA6F00CC9C1E /* GPUImageErosionFilter.m in Sources */ = {isa = PBXBuildFile; fileRef = BC56D84E157ADA6F00CC9C1E /* GPUImageErosionFilter.m */; };
118+
BC57607919441DD90096FFA5 /* CoreMedia.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = BCB5E77814E20BAF00701302 /* CoreMedia.framework */; };
119+
BC57607A19441DE00096FFA5 /* CoreVideo.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = BCB5E77614E20BA800701302 /* CoreVideo.framework */; };
120+
BC57607B19441DE80096FFA5 /* OpenGLES.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = BCB5E77414E20B9700701302 /* OpenGLES.framework */; };
121+
BC57607C19441DF10096FFA5 /* QuartzCore.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = BCB5E77214E20B9100701302 /* QuartzCore.framework */; };
122+
BC57607D19441DF60096FFA5 /* AVFoundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = BCB5E77014E20B8A00701302 /* AVFoundation.framework */; };
123+
BC57607E19441E010096FFA5 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = BCB5E76E14E20B7F00701302 /* UIKit.framework */; };
124+
BC57607F19441E060096FFA5 /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = BCF1A33714DDB1EC00852800 /* Foundation.framework */; };
125+
BC57608019441E610096FFA5 /* GPUImageContext.m in Sources */ = {isa = PBXBuildFile; fileRef = BCB5E76B14E20AD700701302 /* GPUImageContext.m */; };
118126
BC61F4B116B9CAEB009F6234 /* GPUImagePoissonBlendFilter.m in Sources */ = {isa = PBXBuildFile; fileRef = 46A8097C16B8A6A2000C29ED /* GPUImagePoissonBlendFilter.m */; };
119127
BC6C55401730679D00EB222D /* GPUImageLaplacianFilter.h in Headers */ = {isa = PBXBuildFile; fileRef = BC6C553E1730679D00EB222D /* GPUImageLaplacianFilter.h */; };
120128
BC6C55411730679D00EB222D /* GPUImageLaplacianFilter.m in Sources */ = {isa = PBXBuildFile; fileRef = BC6C553F1730679D00EB222D /* GPUImageLaplacianFilter.m */; };
@@ -471,7 +479,6 @@
471479
BCD81F2B194404F8007133DB /* GPUImageTextureOutput.h in Headers */ = {isa = PBXBuildFile; fileRef = BCB6B8B91505BF940041703B /* GPUImageTextureOutput.h */; settings = {ATTRIBUTES = (Public, ); }; };
472480
BCD81F2C194404F8007133DB /* GPUImageRawDataOutput.h in Headers */ = {isa = PBXBuildFile; fileRef = BC1B715514F49DAA00ACA2AB /* GPUImageRawDataOutput.h */; settings = {ATTRIBUTES = (Public, ); }; };
473481
BCD81F2D19440604007133DB /* GLProgram.m in Sources */ = {isa = PBXBuildFile; fileRef = BCB5E79314E3275200701302 /* GLProgram.m */; };
474-
BCD81F2E19440604007133DB /* GPUImageContext.m in Sources */ = {isa = PBXBuildFile; fileRef = BCB5E76B14E20AD700701302 /* GPUImageContext.m */; };
475482
BCD81F2F19440604007133DB /* GPUImageFramebuffer.m in Sources */ = {isa = PBXBuildFile; fileRef = BCC887CB18A1CEEB008DB37D /* GPUImageFramebuffer.m */; };
476483
BCD81F3019440604007133DB /* GPUImageFramebufferCache.m in Sources */ = {isa = PBXBuildFile; fileRef = BCC887CF18A1D3AD008DB37D /* GPUImageFramebufferCache.m */; };
477484
BCD81F3119440604007133DB /* GPUImageOutput.m in Sources */ = {isa = PBXBuildFile; fileRef = BCB5E77E14E22E4200701302 /* GPUImageOutput.m */; };
@@ -1047,6 +1054,13 @@
10471054
isa = PBXFrameworksBuildPhase;
10481055
buildActionMask = 2147483647;
10491056
files = (
1057+
BC57607F19441E060096FFA5 /* Foundation.framework in Frameworks */,
1058+
BC57607E19441E010096FFA5 /* UIKit.framework in Frameworks */,
1059+
BC57607D19441DF60096FFA5 /* AVFoundation.framework in Frameworks */,
1060+
BC57607C19441DF10096FFA5 /* QuartzCore.framework in Frameworks */,
1061+
BC57607B19441DE80096FFA5 /* OpenGLES.framework in Frameworks */,
1062+
BC57607A19441DE00096FFA5 /* CoreVideo.framework in Frameworks */,
1063+
BC57607919441DD90096FFA5 /* CoreMedia.framework in Frameworks */,
10501064
);
10511065
runOnlyForDeploymentPostprocessing = 0;
10521066
};
@@ -2026,8 +2040,8 @@
20262040
isa = PBXSourcesBuildPhase;
20272041
buildActionMask = 2147483647;
20282042
files = (
2043+
BC57608019441E610096FFA5 /* GPUImageContext.m in Sources */,
20292044
BCD81F2D19440604007133DB /* GLProgram.m in Sources */,
2030-
BCD81F2E19440604007133DB /* GPUImageContext.m in Sources */,
20312045
BCD81F2F19440604007133DB /* GPUImageFramebuffer.m in Sources */,
20322046
BCD81F3019440604007133DB /* GPUImageFramebufferCache.m in Sources */,
20332047
BCD81F3119440604007133DB /* GPUImageOutput.m in Sources */,
@@ -2452,7 +2466,7 @@
24522466
DYLIB_COMPATIBILITY_VERSION = 1;
24532467
DYLIB_CURRENT_VERSION = 1;
24542468
DYLIB_INSTALL_NAME_BASE = "@rpath";
2455-
ENABLE_NS_ASSERTIONS = NO;
2469+
ENABLE_NS_ASSERTIONS = YES;
24562470
GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
24572471
GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
24582472
INFOPLIST_FILE = Source/iOS/Framework/Info.plist;

0 commit comments

Comments
 (0)