Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/williamkaroldicioccio/gpu_info
A Dart package allowing you to query detailed GPU-related information using the Vulkan API.
https://github.com/williamkaroldicioccio/gpu_info
dart native pub-package vulkan
Last synced: 3 days ago
JSON representation
A Dart package allowing you to query detailed GPU-related information using the Vulkan API.
- Host: GitHub
- URL: https://github.com/williamkaroldicioccio/gpu_info
- Owner: WilliamKarolDiCioccio
- License: mit
- Created: 2024-07-15T18:39:17.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-12T11:28:37.000Z (3 months ago)
- Last Synced: 2024-08-12T12:51:38.192Z (3 months ago)
- Topics: dart, native, pub-package, vulkan
- Language: C++
- Homepage: https://pub.dev/packages/gpu_info
- Size: 79.1 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 gpu_info
The `gpu_info` Dart package allows you to query detailed GPU-related information using the Vulkan API. This package will soon support all platforms! 🌍
### 📢 Note:
This package is being developed as part of the larger [OpenLocalUI](https://github.com/WilliamKarolDiCioccio/open_local_ui) project. Check it out for more exciting features and updates! 🌟
## 📦 Installation
Add `gpu_info` as a dependency in your `pubspec.yaml` file:
```yaml
dependencies:
gpu_info: ^0.1.0
```
### Vulkan SDK Installation
To build the `gpu_info` package, you'll need the Vulkan SDK installed on your system. Below are the commands to install the Vulkan SDK on different platforms:
#### **Windows**
Install the Vulkan SDK using `winget`:
```sh
winget install LunarG.VulkanSDK
```
Alternatively, you can download and install it directly from the [LunarG Vulkan SDK website](https://vulkan.lunarg.com/sdk/home).
#### **Linux**
For Ubuntu or Debian-based distributions, use `apt`:
```sh
sudo apt update
sudo apt install vulkan-sdk
```
For Fedora:
```sh
sudo dnf install vulkan-tools vulkan-loader-devel
```
For Arch Linux:
```sh
sudo pacman -S vulkan-tools vulkan-headers vulkan-validation-layers
```
#### **macOS**
Install the Vulkan SDK using `brew`:
```sh
brew install --cask vulkan-sdk
```
### Verifying the Installation
After installing the Vulkan SDK, you can verify the installation by running:
```sh
vulkaninfo
```
This command should output detailed information about your Vulkan setup, indicating that the SDK has been correctly installed.
## 🚀 Example
Here is a simple example of how to use the `gpu_info` package to retrieve and display GPU information in a Flutter app.
```dart
import 'dart:async';
import 'package:flutter/material.dart';
import 'package:gpu_info/gpu_info.dart';
void main() {
runApp(const MyApp());
}
class MyApp extends StatefulWidget {
const MyApp({super.key});
@override
State createState() => _MyAppState();
}
class _MyAppState extends State {
final _gpuInfoPlugin = GpuInfo();
final List _gpusInfo = [];
@override
void initState() {
super.initState();
initPlatformState();
}
Future initPlatformState() async {
List gpusInfo;
if (!mounted) return;
gpusInfo = await _gpuInfoPlugin.getGpusInfo();
setState(() {
_gpusInfo.addAll(gpusInfo);
});
}
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(
title: const Text('GPU Info Example App'),
),
body: Center(
child: Container(
padding: const EdgeInsets.all(32),
height: 300,
child: ListView.builder(
scrollDirection: Axis.horizontal,
itemCount: _gpusInfo.length,
itemBuilder: (context, index) {
return Card(
child: Padding(
padding: const EdgeInsets.all(16.0),
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Text(
'GPU: ${_gpusInfo[index].deviceName}',
style: TextStyle(fontWeight: FontWeight.bold),
),
SizedBox(height: 8),
Text('Vendor: ${_gpusInfo[index].vendorName}'),
Text('Driver version: ${_gpusInfo[index].driverVersion}'),
Text('Memory: ${_gpusInfo[index].memoryAmount} MB'),
],
),
),
);
},
),
),
),
),
);
}
}
```
### Explanation
This example demonstrates how to use the `gpu_info` package to retrieve and display information about the GPUs available on the system. The `GpuInfo` class is used to query the GPU information, and the results are displayed in a horizontal list view.
- **Fetching Data:** The `initPlatformState` method retrieves the GPU information asynchronously and updates the state.
- **Displaying Data:** The GPU information is displayed in a list view within a `Card` widget.
This example showcases a simple way to integrate the `gpu_info` package into your Flutter app and display GPU details.
For more detailed information, refer to the package documentation and explore the [OpenLocalUI](https://github.com/WilliamKarolDiCioccio/open_local_ui) project for more features and updates.