MCPcopy
hub / github.com/KhronosGroup/Vulkan-Docs / genStruct

Method genStruct

scripts/docgenerator.py:470–494  ·  view source on GitHub ↗

Generate struct.

(self, typeinfo, typeName, alias)

Source from the content-addressed store, hash-verified

468 return body
469
470 def genStruct(self, typeinfo, typeName, alias):
471 """Generate struct."""
472 OutputGenerator.genStruct(self, typeinfo, typeName, alias)
473
474 deprecatedby = None
475 deprecatedlink = None
476 supersededby = None
477 body = self.deprecationComment(typeinfo.elem)
478 body += self.genRequirements(typeName)
479 if alias:
480 if self.conventions.duplicate_aliased_structs:
481 # TODO maybe move this outside the conditional? This would be a visual change.
482 body += f'// {typeName} is an alias for {alias}\n'
483 alias_info = self.registry.typedict[alias]
484 body += self.genStructBody(alias_info, alias)
485 body += '\n\n'
486 body += f'// Equivalent to {alias}\n'
487 body += f"typedef {alias} {typeName};\n"
488 else:
489 body += self.genStructBody(typeinfo, typeName)
490 deprecatedby = self.deprecatedBy(typeinfo)
491 deprecatedlink = typeinfo.deprecatedlink
492 supersededby = typeinfo.supersededby
493
494 self.writeInclude('structs', typeName, body, deprecatedby, deprecatedlink, supersededby)
495
496 def genEnumTable(self, groupinfo, groupName):
497 """Generate tables of enumerant values and short descriptions from

Callers 1

genTypeMethod · 0.95

Calls 5

genRequirementsMethod · 0.95
genStructBodyMethod · 0.95
deprecatedByMethod · 0.95
writeIncludeMethod · 0.95
deprecationCommentMethod · 0.80

Tested by

no test coverage detected