More work in Command Buffers...

command_buffer/client/cross/effect_helper.h

 /*
  * Copyright 2009, Google Inc.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
@@ skipping 32 matching lines @@
 
 class FencedAllocatorWrapper;
 class IdAllocator;
 class CommandBufferHelper;
 
 // A helper class to find parameters in an effect.
 class EffectHelper {
  public:
   // A more usable version of effect_param::Desc
   struct EffectParamDesc {
-    ResourceID id;                     // The resource ID for the param.
+    ResourceId id;                     // The resource ID for the param.
     String name;                       // The name of the param.
     String semantic;                   // The semantic of the param.
     effect_param::DataType data_type;  // The data type of a param.
     unsigned int data_size;            // The size of the data for a param.
     int num_elements;                  // The number of array entries if the
                                        // parameter is an array, 0 otherwise.
     unsigned int cmd_desc_size;        // The size of the effect_param::Desc
                                        // structure (counting strings) for a
                                        // param.
   };
@@ skipping 21 matching lines @@
   // strings with a single command within GetParamStrings, so it should be left
   // alone.
   //
   // The ResourceIDs will be allocated in the param_id_allocator.
   // Temporary buffers will be allocated in the shm_allocator, but they will be
   // freed before the function returns (possibly pending a token). At least
   // sizeof(effect_param::Desc) must be available for this function to succeed.
   // This function will call Finish(), hence will block.
   //
   // Parameters:
-  //   effect_id: the ResourceID of the effect.
+  //   effect_id: the ResourceId of the effect.
   //   descs: A pointer to a vector containing the returned descriptions.
   //   The pointed vector will be cleared.
   // Returns:
   //   true if successful. Reasons for failure are:
   //   - invalid effect_id,
   //   - not enough memory in the shm_allocator_.
-  bool CreateEffectParameters(ResourceID effect_id,
+  bool CreateEffectParameters(ResourceId effect_id,
                               std::vector<EffectParamDesc> *descs);
 
   // Gets the strings for a desc. This will fill in the values for the name and
   // semantic fields.
   // Temporary buffers will be allocated in the shm_allocator, but they will be
   // freed before the function returns (possibly pending a token). At least
   // desc.cmd_desc_size (as returned by CreateEffectParameters) must be
   // available for this function to succeed.
   // This function will call Finish(), hence will block.
   //
   // Parameters:
   //   desc: a pointer to the description for a parameter. The id field should
-  //   be set to the ResourceID of the parameter.
+  //   be set to the ResourceId of the parameter.
   // Returns:
   //   true if successful. Reasons for failure are:
-  //   - invalid parameter ResourceID,
+  //   - invalid parameter ResourceId,
   //   - not enough memory in the shm_allocator_.
   bool GetParamStrings(EffectParamDesc *desc);
 
   // Destroys all parameter resources referenced by the descriptions. The
-  // ResourceID will be freed from the param_id_allocator.
+  // ResourceId will be freed from the param_id_allocator.
   // Parameters:
   //   descs: the vector of descriptions containing the ResourceIDs of the
   //   parameters to destroy.
   void DestroyEffectParameters(const std::vector<EffectParamDesc> &descs);
 
   // Gets all the input stream semantics and semantic indices in an
   // array. These will be retrieved as many as possible at a time. At least
   // sizeof(effect_param::Desc) must be available for this function to succeed.
   // This function will call Finish(), hence will block.
   //
   // Parameters:
-  //   effect_id: the ResourceID of the effect.
+  //   effect_id: the ResourceId of the effect.
   //   descs:  A pointer to a vector containing the returned descriptions.
   //   The pointed vector will be cleared.
   // Returns:
   //   true if successful. Reasons for failure are:
   //   - invalid effect_id,
   //   - not enough memory in the shm_allocator_.
-  bool GetEffectStreams(ResourceID effect_id,
+  bool GetEffectStreams(ResourceId effect_id,
                         std::vector<EffectStreamDesc> *descs);
 
  private:
   CommandBufferHelper *helper_;
   FencedAllocatorWrapper *shm_allocator_;
   unsigned int shm_id_;
   IdAllocator *param_id_allocator_;
 
   DISALLOW_COPY_AND_ASSIGN(EffectHelper);
 };
 
 }  // namespace command_buffer
 }  // namespace o3d
 
 #endif  // O3D_COMMAND_BUFFER_CLIENT_CROSS_EFFECT_HELPER_H_