imgui/examples/apple_example/README.md

# iOS / OSX example

## Introduction

This example is the default XCode "OpenGL" example code, modified to support ImGui and [Synergy](http://synergy-project.org/) to share mouse/keyboard on an iOS device.

It is a rather complex and messy example because of all of the faff required to get an XCode/iOS application running. Refer to the regular OpenGL examples if you want to learn about integrating ImGui. **The opengl3_example/ should also work on OS X and is much simpler.** This is an integration for iOS with Synergy.

Synergy (remote keyboard/mouse) is not required, but it's pretty hard to use ImGui without it. Synergy includes a "uSynergy" library that allows embedding a synergy client, this is what is used here. ImGui supports "TouchPadding", and this is enabled when Synergy is not active.

## How to Use on iOS

* In Synergy, go to Preferences, and uncheck "Use SSL encryption"
* Run the example app.
* Tap the "servername" button in the corner
* Enter the name or the IP of your synergy host
* If you had previously connected to a server, you may need to kill and re-start the app.

## How to Build on OSX

* Make sure you have install `brew`, if not, please refer to [Homebrew Website](http://brew.sh)
* Run the command: `brew install glfw3`
* Double click `imguiex.xcodeproj` and select `imguiex-osx` scheme
* Click `Run` button

## Notes and TODOs

Things that would be nice but I didn't get around to doing:

* iOS software keyboard not supported for text inputs
* iOS hardware (bluetooth) keyboards not supported
* Graceful disconnect/reconnect from uSynergy.
* Copy/Paste not well-supported

## C++ on iOS / OSX

ImGui is a c++ library. If you want to include it directly, rename your Obj-C file to have the ".mm" extension. 

Alternatively, you can wrap your debug code in a C interface, this is what I am demonstrating here with the "debug_hud.h" interface. Either approach works, use whatever you prefer.

In my case, most of my game code is already in C++ so it's not really an issue and I can use ImGui directly.
Remove local glfw3 lib for osx. (+1 squashed commit) Squashed commits: [34cc3b7] Adds osx example. (+6 squashed commits) Squashed commits: [20330f2] Uses glfw by brew install. [0427861] Renames imguiex folder name to imguiex-ios [f9e27e5] Renames ios_example to apple_example. [44f8fe3] Updates the glfw header/library path. [919f279] Renames target from imguiex to imguiex-ios since there is already a imguiex-osx target now. [24395f5] Adds osx example. 2016-04-05 07:49:23 +00:00			`# iOS / OSX example`
iOS example working based on modified OpenGL3 example + Synergy 2015-06-15 16:23:57 +00:00
			`## Introduction`

Update README.md 2016-04-05 21:08:21 +00:00			`This example is the default XCode "OpenGL" example code, modified to support ImGui and [Synergy](http://synergy-project.org/) to share mouse/keyboard on an iOS device.`
iOS example working based on modified OpenGL3 example + Synergy 2015-06-15 16:23:57 +00:00
Update README.md 2016-04-05 21:08:21 +00:00			`It is a rather complex and messy example because of all of the faff required to get an XCode/iOS application running. Refer to the regular OpenGL examples if you want to learn about integrating ImGui. The opengl3_example/ should also work on OS X and is much simpler. This is an integration for iOS with Synergy.`
Examples: Possibly clarified the intent of imgui_impl_* files. 2015-10-13 15:53:43 +00:00
iOS example: shallow tweaks and fixes (untested) 2015-07-08 03:35:09 +00:00			`Synergy (remote keyboard/mouse) is not required, but it's pretty hard to use ImGui without it. Synergy includes a "uSynergy" library that allows embedding a synergy client, this is what is used here. ImGui supports "TouchPadding", and this is enabled when Synergy is not active.`
iOS example working based on modified OpenGL3 example + Synergy 2015-06-15 16:23:57 +00:00
Examples: Apple: Readme tweaks (#575 #247) 2016-04-05 20:50:23 +00:00			`## How to Use on iOS`
iOS example working based on modified OpenGL3 example + Synergy 2015-06-15 16:23:57 +00:00
Examples: Apple: Readme tweaks (#575 #247) 2016-04-05 20:50:23 +00:00			`* In Synergy, go to Preferences, and uncheck "Use SSL encryption"`
			`* Run the example app.`
			`* Tap the "servername" button in the corner`
			`* Enter the name or the IP of your synergy host`
			`* If you had previously connected to a server, you may need to kill and re-start the app.`
iOS example working based on modified OpenGL3 example + Synergy 2015-06-15 16:23:57 +00:00
Update README.md 2016-04-05 21:08:21 +00:00			`## How to Build on OSX`
Remove local glfw3 lib for osx. (+1 squashed commit) Squashed commits: [34cc3b7] Adds osx example. (+6 squashed commits) Squashed commits: [20330f2] Uses glfw by brew install. [0427861] Renames imguiex folder name to imguiex-ios [f9e27e5] Renames ios_example to apple_example. [44f8fe3] Updates the glfw header/library path. [919f279] Renames target from imguiex to imguiex-ios since there is already a imguiex-osx target now. [24395f5] Adds osx example. 2016-04-05 07:49:23 +00:00
			* Make sure you have install `brew`, if not, please refer to [Homebrew Website](http://brew.sh)
			* Run the command: `brew install glfw3`
			* Double click `imguiex.xcodeproj` and select `imguiex-osx` scheme
			* Click `Run` button

iOS example working based on modified OpenGL3 example + Synergy 2015-06-15 16:23:57 +00:00			`## Notes and TODOs`

			`Things that would be nice but I didn't get around to doing:`

			`* iOS software keyboard not supported for text inputs`
			`* iOS hardware (bluetooth) keyboards not supported`
			`* Graceful disconnect/reconnect from uSynergy.`
			`* Copy/Paste not well-supported`

Remove local glfw3 lib for osx. (+1 squashed commit) Squashed commits: [34cc3b7] Adds osx example. (+6 squashed commits) Squashed commits: [20330f2] Uses glfw by brew install. [0427861] Renames imguiex folder name to imguiex-ios [f9e27e5] Renames ios_example to apple_example. [44f8fe3] Updates the glfw header/library path. [919f279] Renames target from imguiex to imguiex-ios since there is already a imguiex-osx target now. [24395f5] Adds osx example. 2016-04-05 07:49:23 +00:00			`## C++ on iOS / OSX`
Examples: Apple: Readme tweaks (#575 #247) 2016-04-05 20:50:23 +00:00
iOS example: shallow tweaks and fixes (untested) 2015-07-08 03:35:09 +00:00			`ImGui is a c++ library. If you want to include it directly, rename your Obj-C file to have the ".mm" extension.`
iOS example working based on modified OpenGL3 example + Synergy 2015-06-15 16:23:57 +00:00
			`Alternatively, you can wrap your debug code in a C interface, this is what I am demonstrating here with the "debug_hud.h" interface. Either approach works, use whatever you prefer.`

iOS example: shallow tweaks and fixes (untested) 2015-07-08 03:35:09 +00:00			`In my case, most of my game code is already in C++ so it's not really an issue and I can use ImGui directly.`