Vulkan: add docs for the framework generation scripts
Bug: 134185757
Test: ./scripts/code_generator.py && build
Change-Id: I108412fdc672c5513f570ddac9221074a0027cd0
diff --git a/vulkan/scripts/null_generator.py b/vulkan/scripts/null_generator.py
index 2a99a1d..e9faef6 100644
--- a/vulkan/scripts/null_generator.py
+++ b/vulkan/scripts/null_generator.py
@@ -13,13 +13,14 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
-#
-# This script provides the functions for generating the null driver
-# framework directly from the vulkan registry (vk.xml).
+
+"""Generates the null_driver_gen.h and null_driver_gen.cpp.
+"""
import os
import generator_common as gencom
+# Extensions implemented by the driver.
_DRIVER_EXTENSION_DICT = {
'VK_ANDROID_native_buffer',
'VK_EXT_debug_report',
@@ -28,12 +29,19 @@
def _is_driver_function(cmd):
+ """Returns true if the function is implemented by the driver.
+
+ Args:
+ cmd: Vulkan function name.
+ """
if cmd in gencom.extension_dict:
return gencom.extension_dict[cmd] in _DRIVER_EXTENSION_DICT
return True
def gen_h():
+ """Generates the null_driver_gen.h file.
+ """
genfile = os.path.join(os.path.dirname(__file__),
'..', 'nulldrv', 'null_driver_gen.h')
@@ -72,6 +80,8 @@
def gen_cpp():
+ """Generates the null_driver_gen.cpp file.
+ """
genfile = os.path.join(os.path.dirname(__file__),
'..', 'nulldrv', 'null_driver_gen.cpp')