ppapi_simple

native_client_sdk/src/libraries/ppapi_simple/ppapi_simple.h

+// Copyright (c) 2012 The Chromium Authors. All rights reserved.

[binji, 2013/05/23 18:06:49]

2013

+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef PPAPI_SIMPLE_PPAPI_SIMPLE_H_
+#define PPAPI_SIMPLE_PPAPI_SIMPLE_H_
+
+#include "ppapi/c/pp_instance.h"
+#include "utils/macros.h"
+
+EXTERN_C_BEGIN
+
+/**
+ * The ppapi_simple library simplifies the use of the Pepper interfaces by
+ * providing a more traditional 'C' or 'C++' style framework.  The library
+ * automatically creates an instance based on the ppapi_cpp library and
+ * initializes the nacl_io library to provide a POSIX friendly I/O environment.
+ *
+ * For C style development, the PPAPI_SIMPLE_MAIN(XX) macros provide a

[nfullagar1, 2013/05/23 21:58:36]

maybe PPAPI_SIMPLE_REGISTER_MAIN(XX) is a bit more descriptive (for when it is
used in the demos away from this comment block)

+ * mechanism to register entry points for "main", and changes in the view
+ * context, or even callbacks to render a frame.  Use the appropriate
+ * ppapi_simple_main.h, ppapi_simple_main_2d.h, and ppapi_simple_main_3d.h

[binji, 2013/05/23 18:06:49]

3d files aren't in this CL. not uploaded?

[noelallen1, 2013/05/23 22:01:24]

Adding 2D/3D will be a separate CL that will also contain demos using those
functions.

+ * header file to simplify pure compute, 2D, or 3D development for 'C'.
+ *
+ * For C++ style development, use the ppapi_simple_instance.h,
+ * ppapi_simple_instance_2d.h, and ppapi_simple_instance_3d.h headers as
+ * a base class, and overload the appropriate virtual functions such as
+ * Main, ChangeContext, or Render.
+ *
+ */
+
+/**
+ * PSGetInstanceId
+ *
+ * Return the PP_Instance id of this instance of the module.  This is required
+ * by most of the Pepper resouce creation routines.

[binji, 2013/05/23 18:06:49]

sp: resource

[noelallen1, 2013/05/23 22:01:24]

Done.

+ */
+PP_Instance PSGetInstanceId();
+
+
+/**
+ * PSGetInterface
+ *
+ * Return the Pepper instance refered to by 'name'.  Will return a pointer
+ * to the interface, or NULL if not found or not available.
+ */
+const void* PSGetInterface(const char *name);
+
+
+/**
+ * PSUserCreateInstance
+ *
+ * Prototype for the user provided function which creates and configures
+ * the instance object.  This function is defined by one of the macros bellow,

[binji, 2013/05/23 18:06:49]

sp: below

[noelallen1, 2013/05/23 22:01:24]

Done.

+ * or by the equivilent macro in one of the other headers.  For 'C'
+ * development, one of the basic instances which support C callback are used.
+ * For C++, this function should instantiate the user defined instance.  See
+ * the two macros bellow.
+ */
+extern void* PSUserCreateInstance(PP_Instance inst);
+
+
+/**
+ * PPAPI_DECLARE_PARAMS

[nfullagar1, 2013/05/23 21:58:36]

These macros PPAPI_DECLARE_PARAMS, PPAPI_USE_MAIN, PPAPI_USE_CLASS should be
prefixed with PPAPI_SIMPLE_

+ *
+ * Macro for creating the param string array.  Used by the Factory macros
+ * to enable wrapping of the param array with terminating NULL, NULL.
+ */
+#define PPAPI_DECLARE_PARAMS(params, ...)     \
+  static const char* params[] = { __VA_ARGS__ };
+
+
+/**
+ * PPAPI_USE_MAIN
+ *
+ * For use with C projects, this macro calls the provided factory with
+ * configuration information and optional extra arguments which are passed to
+ * the 'main' function.  See the appropriate ppapi_simple_main(XX).h header.
+ */
+#define PPAPI_USE_MAIN(factory, func, ...)                   \
+void* PSUserCreateInstance(PP_Instance inst) {               \
+  PPAPI_DECLARE_PARAMS(params, ##__VA_ARGS__, NULL, NULL)    \
+  return factory(inst, func, params);                        \
+}
+
+
+/**
+ * PPAPI_USE_CLASS
+ *
+ * For use with C++ projects, this macro instantiates the provided class
+ * passing it back to the generic module initialization code.  Simply derive
+ * a class from the appropriate ppapi_simple_instance(XX).h and pass the
+ * class name here.
+ */
+#define PPAPI_USE_CLASS(class, ...)                         \
+void* PSUserCreateInstance(PP_Instance inst) {              \
+  PPAPI_DECLARE_PARAMS(params, ##__VA_ARGS__, NULL, NULL)   \
+  return (void *) new class(inst, params);                  \
+}
+
+EXTERN_C_END
+
+
+#endif  // PPAPI_SIMPLE_PPAPI_SIMPLE_H
+