user: Describe USD Hydra Based Renderer from the Blender manual or Python API, including usage steps and snippets.

assistant: ```
import bpy

class CustomHydraRenderEngine(bpy.types.HydraRenderEngine):
    # Identifier and name in the user interface.
    bl_idname = "CUSTOM_HYDRA_RENDERER"
    bl_label = "Custom Hydra Renderer"

    # Name of the render plugin.
    bl_delegate_id = "HdCustomRendererPlugin"

    # Use MaterialX instead of `UsdPreviewSurface` for materials.
    bl_use_materialx = True

    # Register path to plugin.
    @classmethod
    def register(cls):
        # Make `pxr` module available, for running as `bpy` PIP package.
        bpy.utils.expose_bundled_modules()

        import pxr.Plug
        pxr.Plug.Registry().RegisterPlugins(['/path/to/plugin'])

    # Render settings that will be passed to the delegate.
    def get_render_settings(self, engine_type):
        return {
            'myBoolean': True,
            'myValue': 8,
            'aovToken:Depth': "depth",
        }

    # RenderEngine methods for update, render and draw are implemented in
    # HydraRenderEngine. Optionally extra work can be done before or after
    # by implementing the methods like this.
    def update(self, data, depsgraph):
        super().update(data, depsgraph)
        # Do extra work here.

    def update_render_passes(self, scene, render_layer):
        if render_layer.use_pass_z:
            self.register_pass(scene, render_layer, 'Depth', 1, 'Z', 'VALUE')

# Registration.
def register():
    bpy.utils.register_class(CustomHydraRenderEngine)

def unregister():
    bpy.utils.unregister_class(CustomHydraRenderEngine)

if __name__ == "__main__":
    register()
```

base classes — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct"), [`RenderEngine`](bpy.types.RenderEngine.html#bpy.types.RenderEngine "bpy.types.RenderEngine")

*class* bpy.types.HydraRenderEngine(*RenderEngine*)
:   Base class from USD Hydra based renderers

    get_render_settings(*engine_type: str*)
    :   Provide render settings for `HdRenderDelegate`.

    render(*depsgraph*)

    update(*data*, *depsgraph*)

    view_draw(*context*, *depsgraph*)

    view_update(*context*, *depsgraph*)

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type

### Inherited Properties

|  |  |
| --- | --- |
| - [`bpy_struct.id_data`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_data "bpy.types.bpy_struct.id_data") - [`RenderEngine.is_animation`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.is_animation "bpy.types.RenderEngine.is_animation") - [`RenderEngine.is_preview`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.is_preview "bpy.types.RenderEngine.is_preview") - [`RenderEngine.camera_override`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.camera_override "bpy.types.RenderEngine.camera_override") - [`RenderEngine.layer_override`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.layer_override "bpy.types.RenderEngine.layer_override") - [`RenderEngine.resolution_x`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.resolution_x "bpy.types.RenderEngine.resolution_x") - [`RenderEngine.resolution_y`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.resolution_y "bpy.types.RenderEngine.resolution_y") - [`RenderEngine.temporary_directory`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.temporary_directory "bpy.types.RenderEngine.temporary_directory") - [`RenderEngine.render`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.render "bpy.types.RenderEngine.render") - [`RenderEngine.use_highlight_tiles`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.use_highlight_tiles "bpy.types.RenderEngine.use_highlight_tiles") - [`RenderEngine.bl_idname`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_idname "bpy.types.RenderEngine.bl_idname") | - [`RenderEngine.bl_label`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_label "bpy.types.RenderEngine.bl_label") - [`RenderEngine.bl_use_preview`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_use_preview "bpy.types.RenderEngine.bl_use_preview") - [`RenderEngine.bl_use_postprocess`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_use_postprocess "bpy.types.RenderEngine.bl_use_postprocess") - [`RenderEngine.bl_use_eevee_viewport`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_use_eevee_viewport "bpy.types.RenderEngine.bl_use_eevee_viewport") - [`RenderEngine.bl_use_custom_freestyle`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_use_custom_freestyle "bpy.types.RenderEngine.bl_use_custom_freestyle") - [`RenderEngine.bl_use_image_save`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_use_image_save "bpy.types.RenderEngine.bl_use_image_save") - [`RenderEngine.bl_use_gpu_context`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_use_gpu_context "bpy.types.RenderEngine.bl_use_gpu_context") - [`RenderEngine.bl_use_shading_nodes_custom`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_use_shading_nodes_custom "bpy.types.RenderEngine.bl_use_shading_nodes_custom") - [`RenderEngine.bl_use_spherical_stereo`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_use_spherical_stereo "bpy.types.RenderEngine.bl_use_spherical_stereo") - [`RenderEngine.bl_use_stereo_viewport`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_use_stereo_viewport "bpy.types.RenderEngine.bl_use_stereo_viewport") - [`RenderEngine.bl_use_materialx`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_use_materialx "bpy.types.RenderEngine.bl_use_materialx") |

### Inherited Functions

|  |  |
| --- | --- |
| - [`bpy_struct.as_pointer`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.as_pointer "bpy.types.bpy_struct.as_pointer") - [`bpy_struct.driver_add`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_add "bpy.types.bpy_struct.driver_add") - [`bpy_struct.driver_remove`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_remove "bpy.types.bpy_struct.driver_remove") - [`bpy_struct.get`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.get "bpy.types.bpy_struct.get") - [`bpy_struct.id_properties_clear`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_clear "bpy.types.bpy_struct.id_properties_clear") - [`bpy_struct.id_properties_ensure`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ensure "bpy.types.bpy_struct.id_properties_ensure") - [`bpy_struct.id_properties_ui`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ui "bpy.types.bpy_struct.id_properties_ui") - [`bpy_struct.is_property_hidden`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_hidden "bpy.types.bpy_struct.is_property_hidden") - [`bpy_struct.is_property_overridable_library`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_overridable_library "bpy.types.bpy_struct.is_property_overridable_library") - [`bpy_struct.is_property_readonly`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_readonly "bpy.types.bpy_struct.is_property_readonly") - [`bpy_struct.is_property_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_set "bpy.types.bpy_struct.is_property_set") - [`bpy_struct.items`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.items "bpy.types.bpy_struct.items") - [`bpy_struct.keyframe_delete`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_delete "bpy.types.bpy_struct.keyframe_delete") - [`bpy_struct.keyframe_insert`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_insert "bpy.types.bpy_struct.keyframe_insert") - [`bpy_struct.keys`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keys "bpy.types.bpy_struct.keys") - [`bpy_struct.path_from_id`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_id "bpy.types.bpy_struct.path_from_id") - [`bpy_struct.path_from_module`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_module "bpy.types.bpy_struct.path_from_module") - [`bpy_struct.path_resolve`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_resolve "bpy.types.bpy_struct.path_resolve") - [`bpy_struct.pop`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.pop "bpy.types.bpy_struct.pop") - [`bpy_struct.property_overridable_library_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_overridable_library_set "bpy.types.bpy_struct.property_overridable_library_set") - [`bpy_struct.property_unset`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_unset "bpy.types.bpy_struct.property_unset") - [`bpy_struct.rna_ancestors`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.rna_ancestors "bpy.types.bpy_struct.rna_ancestors") - [`bpy_struct.type_recast`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.type_recast "bpy.types.bpy_struct.type_recast") - [`bpy_struct.values`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.values "bpy.types.bpy_struct.values") - [`RenderEngine.update`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.update "bpy.types.RenderEngine.update") - [`RenderEngine.render`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.render "bpy.types.RenderEngine.render") - [`RenderEngine.render_frame_finish`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.render_frame_finish "bpy.types.RenderEngine.render_frame_finish") - [`RenderEngine.draw`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.draw "bpy.types.RenderEngine.draw") - [`RenderEngine.bake`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bake "bpy.types.RenderEngine.bake") - [`RenderEngine.view_update`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.view_update "bpy.types.RenderEngine.view_update") - [`RenderEngine.view_draw`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.view_draw "bpy.types.RenderEngine.view_draw") - [`RenderEngine.update_script_node`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.update_script_node "bpy.types.RenderEngine.update_script_node") | - [`RenderEngine.update_render_passes`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.update_render_passes "bpy.types.RenderEngine.update_render_passes") - [`RenderEngine.update_custom_camera`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.update_custom_camera "bpy.types.RenderEngine.update_custom_camera") - [`RenderEngine.tag_redraw`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.tag_redraw "bpy.types.RenderEngine.tag_redraw") - [`RenderEngine.tag_update`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.tag_update "bpy.types.RenderEngine.tag_update") - [`RenderEngine.begin_result`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.begin_result "bpy.types.RenderEngine.begin_result") - [`RenderEngine.update_result`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.update_result "bpy.types.RenderEngine.update_result") - [`RenderEngine.end_result`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.end_result "bpy.types.RenderEngine.end_result") - [`RenderEngine.add_pass`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.add_pass "bpy.types.RenderEngine.add_pass") - [`RenderEngine.get_result`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.get_result "bpy.types.RenderEngine.get_result") - [`RenderEngine.test_break`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.test_break "bpy.types.RenderEngine.test_break") - [`RenderEngine.pass_by_index_get`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.pass_by_index_get "bpy.types.RenderEngine.pass_by_index_get") - [`RenderEngine.active_view_get`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.active_view_get "bpy.types.RenderEngine.active_view_get") - [`RenderEngine.active_view_set`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.active_view_set "bpy.types.RenderEngine.active_view_set") - [`RenderEngine.camera_shift_x`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.camera_shift_x "bpy.types.RenderEngine.camera_shift_x") - [`RenderEngine.camera_model_matrix`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.camera_model_matrix "bpy.types.RenderEngine.camera_model_matrix") - [`RenderEngine.use_spherical_stereo`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.use_spherical_stereo "bpy.types.RenderEngine.use_spherical_stereo") - [`RenderEngine.update_stats`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.update_stats "bpy.types.RenderEngine.update_stats") - [`RenderEngine.frame_set`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.frame_set "bpy.types.RenderEngine.frame_set") - [`RenderEngine.update_progress`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.update_progress "bpy.types.RenderEngine.update_progress") - [`RenderEngine.update_memory_stats`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.update_memory_stats "bpy.types.RenderEngine.update_memory_stats") - [`RenderEngine.report`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.report "bpy.types.RenderEngine.report") - [`RenderEngine.error_set`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.error_set "bpy.types.RenderEngine.error_set") - [`RenderEngine.bind_display_space_shader`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bind_display_space_shader "bpy.types.RenderEngine.bind_display_space_shader") - [`RenderEngine.unbind_display_space_shader`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.unbind_display_space_shader "bpy.types.RenderEngine.unbind_display_space_shader") - [`RenderEngine.support_display_space_shader`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.support_display_space_shader "bpy.types.RenderEngine.support_display_space_shader") - [`RenderEngine.get_preview_pixel_size`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.get_preview_pixel_size "bpy.types.RenderEngine.get_preview_pixel_size") - [`RenderEngine.free_blender_memory`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.free_blender_memory "bpy.types.RenderEngine.free_blender_memory") - [`RenderEngine.tile_highlight_set`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.tile_highlight_set "bpy.types.RenderEngine.tile_highlight_set") - [`RenderEngine.tile_highlight_clear_all`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.tile_highlight_clear_all "bpy.types.RenderEngine.tile_highlight_clear_all") - [`RenderEngine.register_pass`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.register_pass "bpy.types.RenderEngine.register_pass") - [`RenderEngine.bl_rna_get_subclass`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_rna_get_subclass "bpy.types.RenderEngine.bl_rna_get_subclass") - [`RenderEngine.bl_rna_get_subclass_py`](bpy.types.RenderEngine.html#bpy.types.RenderEngine.bl_rna_get_subclass_py "bpy.types.RenderEngine.bl_rna_get_subclass_py") |