rafx-api 0.0.16

#[cfg(any(
    feature = "rafx-dx12",
    feature = "rafx-metal",
    feature = "rafx-vulkan",
    feature = "rafx-gles2",
    feature = "rafx-gles3"
))]
use crate::{
    RafxImmutableSamplerKey, RafxImmutableSamplers, RafxPipelineType, RafxResult,
    RafxRootSignatureDef, RafxShaderResource, RafxShaderStageFlags,
};

#[cfg(any(
    feature = "rafx-dx12",
    feature = "rafx-metal",
    feature = "rafx-vulkan",
    feature = "rafx-gles2",
    feature = "rafx-gles3"
))]
pub(crate) static NEXT_TEXTURE_ID: std::sync::atomic::AtomicU32 =
    std::sync::atomic::AtomicU32::new(1);

#[cfg(any(
    feature = "rafx-dx12",
    feature = "rafx-metal",
    feature = "rafx-vulkan",
    feature = "rafx-gles2",
    feature = "rafx-gles3"
))]
use fnv::FnvHashMap;

#[cfg(any(feature = "rafx-dx12", feature = "rafx-vulkan",))]
impl Into<gpu_allocator::MemoryLocation> for crate::RafxMemoryUsage {
    fn into(self) -> gpu_allocator::MemoryLocation {
        use crate::RafxMemoryUsage;
        use gpu_allocator::MemoryLocation;
        match self {
            RafxMemoryUsage::Unknown => MemoryLocation::Unknown,
            RafxMemoryUsage::GpuOnly => MemoryLocation::GpuOnly,
            RafxMemoryUsage::CpuOnly => MemoryLocation::CpuToGpu,
            RafxMemoryUsage::CpuToGpu => MemoryLocation::CpuToGpu,
            RafxMemoryUsage::GpuToCpu => MemoryLocation::GpuToCpu,
        }
    }
}

#[cfg(any(
    feature = "rafx-dx12",
    feature = "rafx-metal",
    feature = "rafx-vulkan",
    feature = "rafx-gles2",
    feature = "rafx-gles3"
))]
pub(crate) fn find_immutable_sampler_index(
    samplers: &[RafxImmutableSamplers],
    name: &Option<String>,
    set_index: u32,
    binding: u32,
) -> Option<usize> {
    for (sampler_index, sampler) in samplers.iter().enumerate() {
        match &sampler.key {
            RafxImmutableSamplerKey::Name(sampler_name) => {
                if let Some(name) = name {
                    if name == sampler_name {
                        return Some(sampler_index);
                    }
                }
            }
            RafxImmutableSamplerKey::Binding(sampler_set_index, sampler_binding) => {
                if set_index == *sampler_set_index && binding == *sampler_binding {
                    return Some(sampler_index);
                }
            }
        }
    }

    None
}

#[cfg(any(
    feature = "rafx-dx12",
    feature = "rafx-metal",
    feature = "rafx-vulkan",
    feature = "rafx-gles2",
    feature = "rafx-gles3"
))]
pub(crate) fn merge_resources<'a>(
    root_signature_def: &RafxRootSignatureDef<'a>
) -> RafxResult<(
    RafxPipelineType,
    Vec<RafxShaderResource>,
    FnvHashMap<&'a String, usize>,
)> {
    let mut merged_resources: Vec<RafxShaderResource> = vec![];
    let mut merged_resources_name_index_map = FnvHashMap::default();
    let mut pipeline_type = None;

    // Make sure all shaders are compatible/build lookup of shared data from them
    for shader in root_signature_def.shaders {
        log::trace!(
            "Merging resources from shader with reflection info: {:?}",
            shader.pipeline_reflection()
        );
        let pipeline_reflection = shader.pipeline_reflection();

        let shader_pipeline_type = if pipeline_reflection
            .shader_stages
            .intersects(RafxShaderStageFlags::COMPUTE)
        {
            RafxPipelineType::Compute
        } else {
            RafxPipelineType::Graphics
        };

        if pipeline_type.is_none() {
            pipeline_type = Some(shader_pipeline_type);
        } else if pipeline_type != Some(shader_pipeline_type) {
            log::error!("Shaders with different pipeline types are sharing a root signature");
            Err("Shaders with different pipeline types are sharing a root signature")?;
        }

        for resource in &pipeline_reflection.resources {
            log::trace!(
                "  Merge resource (set={:?} binding={:?} name={:?})",
                resource.set_index,
                resource.binding,
                resource.name
            );

            let existing_resource_index = resource
                .name
                .as_ref()
                .and_then(|x| merged_resources_name_index_map.get(x));

            if let Some(&existing_resource_index) = existing_resource_index {
                log::trace!("    Resource with this name already exists");
                //
                // This binding name already exists, make sure they match up. Then merge
                // the shader stage flags.
                //
                let existing_resource: &mut RafxShaderResource =
                    &mut merged_resources[existing_resource_index];
                if existing_resource.set_index != resource.set_index {
                    let message = format!(
                        "Shader resource (set={:?} binding={:?} name={:?}) has mismatching set {:?} and {:?} across shaders in same root signature",
                        resource.set_index,
                        resource.binding,
                        resource.name,
                        resource.set_index,
                        existing_resource.set_index
                    );
                    log::error!("{}", message);
                    Err(message)?;
                }

                if existing_resource.binding != resource.binding {
                    let message = format!(
                        "Shader resource (set={:?} binding={:?} name={:?}) has mismatching binding {:?} and {:?} across shaders in same root signature",
                        resource.set_index,
                        resource.binding,
                        resource.name,
                        resource.binding,
                        existing_resource.binding
                    );
                    log::error!("{}", message);
                    Err(message)?;
                }

                verify_resources_can_overlap(resource, existing_resource)?;

                // for previous_resource in &mut resources {
                //     if previous_resource.name == resource.name {
                //         previous_resource.used_in_shader_stages |= resource.used_in_shader_stages;
                //     }
                // }

                existing_resource.used_in_shader_stages |= resource.used_in_shader_stages;
            } else {
                //
                // We have not seen a resource by this name yet or the name is not set. See if
                // it overlaps an existing binding that doesn't share the same name.
                //
                let mut existing_index = None;
                for (index, x) in merged_resources.iter().enumerate() {
                    if x.used_in_shader_stages
                        .intersects(resource.used_in_shader_stages)
                        && x.binding == resource.binding
                        && x.set_index == resource.set_index
                    {
                        existing_index = Some(index)
                    }
                }

                if let Some(existing_index) = existing_index {
                    log::trace!("    No resource by this name exists yet, checking if it overlaps with a previous resource");

                    //
                    // It's a new binding name that overlaps an existing binding. Check that
                    // they are compatible types. If they are, alias them.
                    //
                    let existing_resource = &mut merged_resources[existing_index];
                    verify_resources_can_overlap(resource, existing_resource)?;

                    if let Some(name) = &resource.name {
                        let old = merged_resources_name_index_map.insert(name, existing_index);
                        assert!(old.is_none());
                    }

                    log::trace!(
                        "Adding shader flags {:?} the existing resource",
                        resource.used_in_shader_stages
                    );
                    existing_resource.used_in_shader_stages |= resource.used_in_shader_stages;
                } else {
                    //
                    // It's a new binding name and doesn't overlap with existing bindings
                    //
                    log::trace!("    Does not collide with existing bindings");
                    if let Some(name) = &resource.name {
                        merged_resources_name_index_map.insert(name, merged_resources.len());
                    }
                    merged_resources.push(resource.clone());
                }
            }
        }
    }

    Ok((
        pipeline_type.unwrap(),
        merged_resources,
        merged_resources_name_index_map,
    ))
}

#[cfg(any(
    feature = "rafx-dx12",
    feature = "rafx-metal",
    feature = "rafx-vulkan",
    feature = "rafx-gles2",
    feature = "rafx-gles3"
))]
fn verify_resources_can_overlap(
    resource: &RafxShaderResource,
    previous_resource: &RafxShaderResource,
) -> RafxResult<()> {
    if previous_resource.element_count_normalized() != resource.element_count_normalized() {
        let message = format!(
            "Shader resource (set={:?} binding={:?} name={:?}) has mismatching element_count {:?} and {:?} across shaders in same root signature",
            resource.set_index,
            resource.binding,
            resource.name,
            resource.element_count_normalized(),
            previous_resource.element_count_normalized()
        );
        log::error!("{}", message);
        Err(message)?;
    }

    if previous_resource.size_in_bytes != resource.size_in_bytes {
        let message = format!(
            "Shader resource (set={:?} binding={:?} name={:?}) has mismatching size_in_bytes {:?} and {:?} across shaders in same root signature",
            resource.set_index,
            resource.binding,
            resource.name,
            resource.size_in_bytes,
            previous_resource.size_in_bytes
        );
        log::error!("{}", message);
        Err(message)?;
    }

    if previous_resource.resource_type != resource.resource_type {
        let message = format!(
            "Shader resource (set={:?} binding={:?} name={:?}) has mismatching resource_type {:?} and {:?} across shaders in same root signature",
            resource.set_index,
            resource.binding,
            resource.name,
            resource.resource_type,
            previous_resource.resource_type
        );
        log::error!("{}", message);
        Err(message)?;
    }

    Ok(())
}