wisAdapterQueryGetAdapterDesc Struct Reference

Detailed Description

Specification

---

To get the description of an adapter from an AdapterQuery, call:

C Version:

// Provided by Wisdom 0.7.0.
WisResult wisAdapterQueryGetAdapterDesc(const WisAdapterQuery* self,
                                        size_t                 index,
                                        WisAdapterDesc*        desc);

C Implementation Specific Version:

// Provided by Wisdom 0.7.0.
WisResult wisVKAdapterQueryGetAdapterDesc(const WisVKAdapterQuery* self,
                                          size_t                   index,
                                          WisAdapterDesc*          desc);
 
// Provided by Wisdom 0.7.0.
WisResult wisDX12AdapterQueryGetAdapterDesc(const WisDX12AdapterQuery* self,
                                            size_t                     index,
                                            WisAdapterDesc*            desc);

C++ Version:

namespace wis{
// Provided by Wisdom 0.7.0.
WIS_NODISCARD wis::AdapterDesc AdapterQuery::GetAdapterDesc(std::size_t  index,
                                                            wis::Result& out_result) const noexcept;
}

C++ Implementation Specific Version:

namespace wis{
// Provided by Wisdom 0.7.0.
WIS_NODISCARD wis::AdapterDesc VKAdapterQuery::GetAdapterDesc(std::size_t  index,
                                                              wis::Result& out_result) const noexcept;
 
// Provided by Wisdom 0.7.0.
WIS_NODISCARD wis::AdapterDesc DX12AdapterQuery::GetAdapterDesc(std::size_t  index,
                                                                wis::Result& out_result) const noexcept;
}

Parameters

---

• this self self is a pointer to the valid WisAdapterQuery instance.
• index defines the index of the adapter to get the description for. It must be less than the value returned by wisAdapterQueryGetAdapterCount.
• desc points to WisAdapterDesc, which is initialized on success.
• return denoting the outcome of operation.

Description

---

index selects which adapter's description to retrieve from the AdapterQuery. The index is zero-based. desc must be a valid pointer and it is populated with the description of the specified adapter, including details such as its name, type, and capabilities. The information about memory resources may not be identical across different implementations, because underlying graphics APIs expose varying levels of detail about adapter memory. `

See Also

---