OpenKODE 1.0 Provisional Specification revision 1 Edited by Tim Renouf OpenKODE 1.0 Provisional Specification: revision 1 Copyright © 2006,2007 The Khronos Group Inc. All Rights Reserved. This specification is protected by copyright laws and contains material proprietary to the Khronos Group, Inc. It or any components may not be reproduced, republished, distributed, transmitted, displayed, broadcast or otherwise exploited in any manner without the express prior written permission of Khronos Group. You may use this specification for implementing the functionality therein, without altering or removing any trademark, copyright or other notice from the specification, but the receipt or possession of this specification does not convey any rights to reproduce, disclose, or distribute its contents, or to manufacture, use, or sell anything that it may describe, in whole or in part. Khronos Group grants express permission to any current Promoter, Contributor or Adopter member of Khronos to copy and redistribute UNMODIFIED versions of this specification in any fashion, provided that NO CHARGE is made for the specification and the latest available update of the specification for any version of the API is used whenever possible. Such distributed specification may be re-formatted AS LONG AS the contents of the specification are not changed in any way. The specification may be incorporated into a product that is sold as long as such product includes significant independent work developed by the seller. A link to the current version of this specification on the Khronos Group web-site should be included whenever possible with specification distributions. Khronos Group makes no, and expressly disclaims any, representations or warranties, express or implied, regarding this specification, including, without limitation, any implied warranties of merchantability or fitness for a particular purpose or non-infringement of any intellectual property. Khronos Group makes no, and expressly disclaims any, warranties, express or implied, regarding the correctness, accuracy, completeness, timeliness, and reliability of the specification. Under no circumstances will the Khronos Group, or any of its Promoters, Contributors or Members or their respective partners, officers, directors, employees, agents or representatives be liable for any damages, whether direct, indirect, special or consequential damages for lost revenues, lost profits, or otherwise, arising from or in connection with these materials. Khronos, OpenKODE, OpenVG, OpenSL ES and OpenMAX AL are trademarks of The Khronos Group Inc. OpenGL ES is a trademark of Silicon Graphics, Inc. Windows is a registered trademark of Microsoft, Inc. Java is a trademark of Sun Microsystems, Inc. Symbian is a trademark of Symbian Software Limited. BREW is a trademark of QUALCOMM, Inc. Table of Contents 1. Introduction ............................................................................................................................1 1.1. Specification conventions ............................................................................................... 1 1.1.1. Non-normative text ............................................................................................. 1 1.2. Overview .....................................................................................................................1 1.2.1. OpenKODE and OpenKODE Core ......................................................................... 1 I. OpenKODE 1.0 Provisional ....................................................................................................... 3 2. OpenKODE conformance .................................................................................................. 5 2.1. Conformant OpenKODE implementation ................................................................... 5 2.1.1. EGL .........................................................................................................5 2.1.2. Future directions ......................................................................................... 7 2.2. Conformance tests ................................................................................................. 7 II. OpenKODE Core 1.0 Provisional ............................................................................................... 9 3. Overview ..................................................................................................................... 11 3.1. OpenKODE Core ................................................................................................ 11 3.1.1. OpenKODE Core programming environment ................................................. 11 3.1.2. API conventions (KD and kd prefixes) .......................................................... 12 4. Programming environment .............................................................................................. 13 4.1. Header file ......................................................................................................... 13 4.1.1. Note for implementers ............................................................................... 13 4.1.2. Future directions ....................................................................................... 13 4.2. C subset ............................................................................................................ 13 4.2.1. Rationale ................................................................................................. 14 4.3. OpenKODE Core structures .................................................................................. 14 4.4. OpenKODE Core functions ................................................................................... 14 4.4.1. Note for implementers ............................................................................... 14 4.5. Threading .......................................................................................................... 14 4.5.1. Future directions ....................................................................................... 15 4.6. Types ................................................................................................................ 15 4.6.1. Rationale ................................................................................................. 16 4.7. Constants ........................................................................................................... 16 5. Errors .......................................................................................................................... 19 5.1. Introduction ....................................................................................................... 19 5.2. Constants ........................................................................................................... 19 5.3. Functions ........................................................................................................... 20 5.3.1. kdGetError .............................................................................................. 20 5.3.2. kdSetError ............................................................................................... 20 6. Versioning and attribute queries ....................................................................................... 23 6.1. Introduction ....................................................................................................... 23 6.2. Functions ........................................................................................................... 23 6.2.1. kdQueryAttribi ......................................................................................... 23 6.2.2. kdQueryAttribcv ....................................................................................... 23 6.2.3. kdQueryIndexedAttribcv ............................................................................ 24 6.2.4. kdGetProcAddress .................................................................................... 25 7. Events ......................................................................................................................... 27 7.1. Introduction ....................................................................................................... 27 7.1.1. Event model ............................................................................................ 27 7.2. Types ................................................................................................................ 28 7.2.1. KDEvent ................................................................................................. 28 7.3. Functions ........................................................................................................... 29 7.3.1. kdWaitEvent ............................................................................................ 29 7.3.2. kdSetEventUserptr .................................................................................... 30 7.3.3. kdDefaultEvent ........................................................................................ 31 7.3.4. kdPumpEvents ......................................................................................... 31 v 7.3.5. kdInstallCallback ...................................................................................... 32 7.3.6. kdCreateEvent .......................................................................................... 33 7.3.7. kdPostEvent ...........................................................................................